Question Answering - Get Answers From Text

Referência

Serviço:: Azure AI Services

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

Responde à pergunta especificada usando o texto fornecido no corpo.

POST {Endpoint}/language/:query-text?api-version=2023-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string (uri)	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
question	True	string	Pergunta do usuário para consultar os registros de texto especificados.
records	True	TextDocument[]	Registros de texto a serem pesquisados para determinada pergunta.
language		string	Idioma dos registros de texto. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão.
stringIndexType		StringIndexType	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é elementos de texto (Graphemes) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.

Respostas

Nome	Tipo	Description
200 OK	AnswersFromTextResult	A solicitação foi bem-sucedida.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

AnswersFromTextResult

A solicitação foi bem-sucedida.

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

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

Escopos

Nome	Description
https://cognitiveservices.azure.com/.default

Exemplos

Successful query

Solicitação de exemplo

HTTP

POST {Endpoint}/language/:query-text?api-version=2023-04-01

{
  "question": "how long it takes to charge surface?",
  "records": [
    {
      "id": "1",
      "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it."
    },
    {
      "id": "2",
      "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface."
    }
  ],
  "language": "en"
}

Resposta de exemplo

Código de status:: 200

{
  "answers": [
    {
      "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "answerSpan": {
        "confidenceScore": 0,
        "length": 45,
        "offset": 28,
        "text": "two to four hours"
      },
      "confidenceScore": 0.93,
      "id": "1",
      "length": 224,
      "offset": 0
    },
    {
      "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "answerSpan": {
        "confidenceScore": 0,
        "length": 25,
        "offset": 8,
        "text": "two to four hours"
      },
      "confidenceScore": 0.92,
      "id": "1",
      "length": 224,
      "offset": 20
    },
    {
      "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.",
      "answerSpan": null,
      "confidenceScore": 0.05,
      "id": "1",
      "length": 244,
      "offset": 110
    }
  ]
}

Definições

Nome	Description
AnswersFromTextOptions	Os parâmetros de pergunta e registro de texto a serem respondidos.
AnswersFromTextResult	Representa os resultados da resposta.
AnswerSpan	Objeto de intervalo de resposta do QnA.
Error	O objeto de resposta de erro retornado quando o serviço encontra alguns erros durante o processamento da solicitação.
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.
StringIndexType	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é elementos de texto (Graphemes) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.
TextAnswer	Representa o resultado da resposta.
TextDocument	Represente o registro de texto de entrada a ser consultado.

AnswersFromTextOptions

Objeto

Os parâmetros de pergunta e registro de texto a serem respondidos.

Nome	Tipo	Valor padrão	Description
language	string		Idioma dos registros de texto. Esta é a representação BCP-47 de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, use "en" para inglês como padrão.
question	string		Pergunta do usuário para consultar os registros de texto especificados.
records	TextDocument[]		Registros de texto a serem pesquisados para determinada pergunta.
stringIndexType	StringIndexType	TextElements_v8	Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é elementos de texto (Graphemes) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Objeto

Representa os resultados da resposta.

Nome	Tipo	Description
answers	TextAnswer[]	Representa os resultados da resposta.

AnswerSpan

Objeto

Objeto de intervalo de resposta do QnA.

Nome	Tipo	Description
confidenceScore	number (double) minimum: 0 maximum: 1	A pontuação prevista de intervalo de respostas varia de 0 a 1.
length	integer (int32)	O comprimento do intervalo de respostas.
offset	integer (int32)	O deslocamento do intervalo de respostas desde o início da resposta.
text	string	Texto previsto do intervalo de respostas.

Error

Objeto

O objeto de resposta de erro retornado quando o serviço encontra alguns erros durante o processamento da solicitação.

Nome	Tipo	Description
code	ErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
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 pelo ser humano do erro.
target	string	O destino do erro.

ErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
AzureCognitiveSearchIndexLimitReached	Erro atingido no limite de índice do Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Erro não encontrado no índice do Azure Cognitive Search
AzureCognitiveSearchNotFound	Erro não encontrado no Azure Cognitive Search
AzureCognitiveSearchThrottling	Erro de limitação do Azure Cognitive Search
Conflict	Erro de conflito
Forbidden	Erro de acesso proibido
InternalServerError	Erro interno do servidor
InvalidArgument	Erro de argumento inválido
InvalidRequest	Erro de solicitação inválido
NotFound	Erro não encontrado
OperationNotFound	Erro de operação não encontrada
ProjectNotFound	Erro não encontrado no projeto
QuotaExceeded	Erro de cota excedido
ServiceUnavailable	Erro de serviço indisponível
Timeout	Erro de tempo limite
TooManyRequests	Erro de muitas solicitações
Unauthorized	Erro de acesso não autorizado
Warning	Erro de aviso

ErrorResponse

Objeto

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
AzureCognitiveSearchNotFound	Erro não encontrado no Azure Cognitive Search
AzureCognitiveSearchThrottling	Erro de limitação do Azure Cognitive Search
EmptyRequest	Erro de solicitação vazia
ExtractionFailure	Erro de falha de extração
InvalidCountryHint	Erro de dica de país inválido
InvalidDocument	Erro de documento inválido
InvalidDocumentBatch	Erro em lote de documento inválido
InvalidParameterValue	Erro de valor de parâmetro inválido
InvalidRequest	Erro de solicitação inválido
InvalidRequestBodyFormat	Erro de formato do corpo da solicitação inválido
KnowledgeBaseNotFound	Erro não encontrado na base de dados de conhecimento
MissingInputDocuments	Erro de documentos de entrada ausentes
ModelVersionIncorrect	Erro incorreto da versão do modelo
UnsupportedLanguageCode	Erro de código de idioma sem suporte

InnerErrorModel

Objeto

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.

Nome	Tipo	Description
code	InnerErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
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	Destino de erro.

StringIndexType

Enumeração

Especifica o método usado para interpretar deslocamentos de cadeia de caracteres. O padrão é elementos de texto (Graphemes) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.

Valor	Description
TextElements_v8	Os valores de deslocamento e comprimento retornados corresponderão a TextElements (clusters Graphemes e Grapheme) confirmando o padrão Unicode 8.0.0. Use essa opção se o aplicativo for escrito no .Net Framework ou no .Net Core e você usará StringInfo.
UnicodeCodePoint	Os valores de deslocamento e comprimento retornados corresponderão aos pontos de código Unicode. Use essa opção se o aplicativo for escrito em um idioma que dê suporte ao Unicode, por exemplo, Python.
Utf16CodeUnit	Os valores de deslocamento e comprimento retornados corresponderão às unidades de código UTF-16. Use essa opção se o aplicativo for escrito em um idioma que dê suporte ao Unicode, por exemplo Java, JavaScript.

TextAnswer

Objeto

Representa o resultado da resposta.

Nome	Tipo	Description
answer	string	Responder.
answerSpan	AnswerSpan	Objeto de intervalo de resposta em relação à pergunta do usuário.
confidenceScore	number (double) minimum: 0 maximum: 1	pontuação de confiança de resposta, o valor varia de 0 a 1.
id	string	ID do registro.
length	integer (int32)	O comprimento da frase.
offset	integer (int32)	O deslocamento da sentença desde o início do documento.

TextDocument

Objeto

Represente o registro de texto de entrada a ser consultado.

Nome	Tipo	Description
id	string	Identificador exclusivo para o registro de texto.
text	string	Conteúdo de texto do registro.

Compartilhar via

Question Answering - Get Answers From Text

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Escopos

Exemplos

Successful query

Solicitação de exemplo

Resposta de exemplo

Definições

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument