Discovery - Suggest

Referência

Serviço:: Purview

Versão da API:: 2023-09-01

Obtenha sugestões de pesquisa por critérios de consulta.

POST {endpoint}/datamap/api/search/suggest?api-version=2023-09-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
filter		O filtro para a pesquisa.
keywords	string	As palavras-chave aplicadas a todos os campos que dão suporte à operação de sugestão. Ele deve ter pelo menos 1 caractere e não mais do que 100 caracteres. No esquema de índice, definimos um sugestor padrão que lista todos os campos com suporte e especifica um modo de pesquisa.
limit	integer	O número de sugestões que esperamos retornar. O valor padrão é 5. O valor deve ser um número entre 1 e 100.

Respostas

Nome	Tipo	Description
200 OK	SuggestResult	A solicitação foi bem-sucedida.
Other Status Codes	AtlasErrorResponse	Uma resposta de erro inesperada.

Segurança

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
https://purview.azure.net/.default

Exemplos

Discovery_Suggest

Solicitação de exemplo

HTTP

POST {endpoint}/datamap/api/search/suggest?api-version=2023-09-01

{
  "keywords": "exampledata",
  "filter": {
    "and": [
      {
        "entityType": "azure_blob_path",
        "includeSubTypes": false
      }
    ]
  },
  "limit": 10
}

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "@search.text": "<em>exampledata.csv</em>",
      "@search.score": 9.81402,
      "description": "Example Description",
      "id": "af7a01b0-1b14-4ab6-83a5-12cb11a717ed",
      "name": "exampledata.csv",
      "owner": "$superuser",
      "qualifiedName": "https://exampleaccount.blob.core.windows.net/examplepath/exampledata.csv",
      "entityType": "azure_blob_path",
      "assetType": [
        "Azure Blob Storage"
      ],
      "classification": [
        "MICROSOFT.GOVERNMENT.US.PASSPORT_NUMBER"
      ],
      "contact": [
        {
          "id": "8a597ffc-6993-4772-ac25-86b7251e1234",
          "info": "Example Info",
          "contactType": "Expert"
        }
      ],
      "label": [
        "Example.Label"
      ],
      "term": [
        {
          "name": "Example Term",
          "glossaryName": "Glossary"
        }
      ]
    }
  ]
}

Definições

Nome	Description
AtlasErrorResponse	Uma resposta de erro do serviço
ContactSearchResultValue	O contato na pesquisa e sugerem o resultado.
SuggestOptions	O conteúdo da solicitação de sugestão.
SuggestResult	O item de resultado da pesquisa sugere.
SuggestResultValue	O item de valor da pesquisa sugere.
TermSearchResultValue	O contexto.

AtlasErrorResponse

Uma resposta de erro do serviço

Nome	Tipo	Description
errorCode	string	O código de erro.
errorMessage	string	A mensagem de erro.
requestId	string	A ID da solicitação.

ContactSearchResultValue

O contato na pesquisa e sugerem o resultado.

Nome	Tipo	Description
contactType	string	O tipo do contato. Ele pode ser Especialista ou Proprietário de uma entidade. Pode ser Expert ou Steward para um termo glossário.
id	string	O GUID do contato.
info	string	A descrição do contato.

SuggestOptions

O conteúdo da solicitação de sugestão.

Nome	Tipo	Description
filter		O filtro para a pesquisa.
keywords	string	As palavras-chave aplicadas a todos os campos que dão suporte à operação de sugestão. Ele deve ter pelo menos 1 caractere e não mais do que 100 caracteres. No esquema de índice, definimos um sugestor padrão que lista todos os campos com suporte e especifica um modo de pesquisa.
limit	integer	O número de sugestões que esperamos retornar. O valor padrão é 5. O valor deve ser um número entre 1 e 100.

SuggestResult

O item de resultado da pesquisa sugere.

Nome	Tipo	Description
value	SuggestResultValue[]	O valor do resultado

SuggestResultValue

O item de valor da pesquisa sugere.

Nome	Tipo	Description
@search.score	number	A pontuação de pesquisa calculada pelo mecanismo de pesquisa. Os resultados são ordenados por pontuação de pesquisa por padrão.
@search.text	string	O texto de destino que contém o palavra-chave como prefixo. O palavra-chave é encapsulado com marca de ênfase.
assetType	string[]	Os tipos de ativo do ativo.
classification	string[]	As classificações do registro.
contact	ContactSearchResultValue[]	Os contatos do ativo.
createTime	integer	A hora de criação do registro. O formato de época do Unix.
description	string	A descrição do ativo.
endorsement	string	O endosso do ativo.
entityType	string	O nome do tipo do ativo.
glossary	string	O nome do glossário do termo.
glossaryType	string	O nome do tipo do termo. Pode ser AtlasGlossary, AtlasGlossaryTerm ou AtlasGlossaryCategory.
id	string	O GUID do registro.
label	string[]	Os rótulos do ativo.
longDescription	string	A definição do termo.
name	string	O nome do registro.
objectType	string	O tipo de objeto do registro. O tipo de objeto é a propriedade de nível superior para distinguir se um registro é um ativo ou um termo.
owner	string	O proprietário do registro.
qualifiedName	string	O nome qualificado do registro.
term	TermSearchResultValue[]	Os termos atribuídos ao ativo.
termStatus	string	O status do termo.
termTemplate	string[]	Os nomes de modelo de termo usados pelo termo.
updateTime	integer	A última hora de atualização do registro. O formato de época do Unix.

TermSearchResultValue

O contexto.

Nome	Tipo	Description
glossaryName	string	O nome do glossário que contém o termo .
guid	string	O GUID do termo.
name	string	O nome do termo.

Compartilhar via