Question Answering Projects - Get Synonyms

Serviço:

Azure AI Services

Versão da API:

2021-10-01

Obtém todos os sinônimos de um projeto.

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/synonyms?api-version=2021-10-01

Com parâmetros opcionais:

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/synonyms?api-version=2021-10-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto de extremidade de Serviços Cognitivos suportado (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	O nome do projeto a ser usado.
api-version	query	True	string	Versão da API do cliente.
maxpagesize	query		integer (int32)	O número máximo de recursos a incluir numa única resposta.
skip	query		integer (int32)	Um deslocamento na coleção do primeiro recurso a ser retornado.
top	query		integer (int32)	O número máximo de recursos a serem retornados da coleção.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respostas

Name	Tipo	Description
200 OK	SynonymAssets	Todos os sinônimos de um projeto.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful query

Pedido de amostra

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1/synonyms?api-version=2021-10-01

Resposta da amostra

Código de estado:

200

{
  "value": [
    {
      "alterations": [
        "qnamaker",
        "qna maker"
      ]
    },
    {
      "alterations": [
        "botframework",
        "bot framework"
      ]
    }
  ]
}

Definições

Name	Description
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
SynonymAssets	Todos os ativos sinónimos para este projeto.
WordAlterations	Coleção de alterações de palavras.

Error

Object

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

ErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable

ErrorResponse

Object

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure

InnerErrorModel

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tipo	Description
code	InnerErrorCode	Um de um conjunto de códigos de erro definido pelo servidor.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Alvo de erro.

SynonymAssets

Object

Todos os ativos sinónimos para este projeto.

Name	Tipo	Description
nextLink	string
value	WordAlterations[]	Coleção de sinônimos.

WordAlterations

Object

Coleção de alterações de palavras.

Name	Tipo	Description
alterations	string[]	Coleção de alterações de palavras.