Question Answering - Get Answers From Text

Referência

Service:: Cognitive Services - Language

API Version:: 2023-04-01

Responde à pergunta especificada com o texto fornecido no corpo.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
Endpoint	path	True	string	Ponto final dos Serviços Cognitivos suportado (por exemplo, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Versão da API de Cliente.

Corpo do Pedido

Name	Necessário	Tipo	Description
question	True	string	Pergunta do utilizador para consultar os registos de texto especificados.
records	True	TextDocument[]	Registos de texto a procurar para uma determinada pergunta.
language		string	Idioma dos registos de texto. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês; "es" para espanhol, etc. Se não estiver definido, utilize "en" para inglês como predefinição.
stringIndexType		StringIndexType	Especifica o método utilizado para interpretar desvios de cadeias. Predefinições para Elementos de Texto (Grafos) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.

Respostas

Name	Tipo	Description
200 OK	AnswersFromTextResult	Uma resposta bem-sucedida para obter respostas do texto de entrada.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

AADToken

Estes são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controlo de acesso baseado em funções do Azure, pode ser utilizado para controlar o acesso às APIs REST Azure Maps. Os controlos de acesso baseados em funções do Azure são utilizados para designar o acesso a uma ou mais Azure Maps conta de recursos ou sub-recursos. Qualquer utilizador, grupo ou principal de serviço pode ter acesso através de uma função incorporada ou de uma função personalizada composta por uma ou mais permissões para Azure Maps APIs REST.

Para implementar cenários, recomendamos que veja os conceitos de autenticação. Em resumo, esta definição de segurança fornece uma solução para modelar aplicações através de objetos com capacidade de controlo de acesso em APIs e âmbitos específicos.

Notas

Esta definição de segurança requer a utilização do x-ms-client-id cabeçalho para indicar a que Azure Maps recurso a que a aplicação está a pedir acesso. Isto pode ser adquirido na API de gestão de Mapas.

O Authorization URL é específico da instância da cloud pública do Azure. As clouds soberanas têm URLs de Autorização exclusivos e configurações do Azure Active Directory. * O controlo de acesso baseado em funções do Azure está configurado a partir do plano de gestão do Azure através de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * A utilização do SDK Web Azure Maps permite a configuração baseada na configuração de uma aplicação para vários casos de utilização.

Atualmente, o Azure Active Directory v1.0 ou v2.0 suporta Trabalho, Escola e Convidados, mas não suporta contas pessoais.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Uma chave de subscrição para um recurso do Serviço de idiomas.

Type: apiKey
In: header

Exemplos

Successful query

Sample Request

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"
}

Sample Response

Status code:: 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.",
      "confidenceScore": 0.93,
      "id": "1",
      "answerSpan": {
        "text": "two to four hours",
        "confidenceScore": 0,
        "offset": 28,
        "length": 45
      },
      "offset": 0,
      "length": 224
    },
    {
      "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.",
      "confidenceScore": 0.92,
      "id": "1",
      "answerSpan": {
        "text": "two to four hours",
        "confidenceScore": 0,
        "offset": 8,
        "length": 25
      },
      "offset": 20,
      "length": 224
    },
    {
      "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.",
      "confidenceScore": 0.05,
      "id": "1",
      "answerSpan": null,
      "offset": 110,
      "length": 244
    }
  ]
}

Definições

Name	Description
AnswersFromTextOptions	Os parâmetros de registo de perguntas e textos a responder.
AnswersFromTextResult	Representa os resultados da resposta.
AnswerSpan	Objeto de intervalo de respostas de FAQ.
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 Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Especifica o método utilizado para interpretar desvios de cadeias. Predefinições para Elementos de Texto (Grafos) 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 registo de texto de entrada a consultar.

AnswersFromTextOptions

Os parâmetros de registo de perguntas e textos a responder.

Name	Tipo	Valor Predefinido	Description
language	string		Idioma dos registos de texto. Trata-se da representação BCP-47 de um idioma. Por exemplo, utilize "en" para inglês; "es" para espanhol, etc. Se não estiver definido, utilize "en" para inglês como predefinição.
question	string		Pergunta do utilizador para consultar os registos de texto especificados.
records	TextDocument[]		Registos de texto a procurar para uma determinada pergunta.
stringIndexType	StringIndexType	TextElements_v8	Especifica o método utilizado para interpretar desvios de cadeias. Predefinições para Elementos de Texto (Grafos) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Representa os resultados da resposta.

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

AnswerSpan

Objeto de intervalo de respostas de FAQ.

Name	Tipo	Description
confidenceScore	number	Classificação prevista do intervalo de respostas, intervalos de valores de 0 a 1.
length	integer	O comprimento do intervalo de respostas.
offset	integer	O desvio do intervalo de respostas desde o início da resposta.
text	string	Texto previsto do intervalo de respostas.

Error

O objeto de erro.

Name	Tipo	Description
code	ErrorCode	Um dos conjuntos de códigos de erro definidos pelo servidor.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a este erro reportado.
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 destino do erro.

ErrorCode

Código de erro legível por humanos.

Name	Tipo	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Conflict	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
QuotaExceeded	string
ServiceUnavailable	string
Timeout	string
TooManyRequests	string
Unauthorized	string
Warning	string

ErrorResponse

Resposta de erro.

Name	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Name	Tipo	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
EmptyRequest	string
ExtractionFailure	string
InvalidCountryHint	string
InvalidDocument	string
InvalidDocumentBatch	string
InvalidParameterValue	string
InvalidRequest	string
InvalidRequestBodyFormat	string
KnowledgeBaseNotFound	string
MissingInputDocuments	string
ModelVersionIncorrect	string
UnsupportedLanguageCode	string

InnerErrorModel

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

Name	Tipo	Description
code	InnerErrorCode	Um dos conjuntos de códigos de erro definidos 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	Destino do erro.

StringIndexType

Especifica o método utilizado para interpretar desvios de cadeias. Predefinições para Elementos de Texto (Grafos) de acordo com Unicode v8.0.0. Para obter informações adicionais, consulte https://aka.ms/text-analytics-offsets.

Name	Tipo	Description
TextElements_v8	string	Os valores de deslocamento e comprimento devolvidos corresponderão a TextElements (clusters Graphemes e Grapheme) confirmando para a norma Unicode 8.0.0. Utilize esta opção se a sua aplicação estiver escrita no .Net Framework ou .Net Core e estiver a utilizar StringInfo.
UnicodeCodePoint	string	Os valores de desvio e comprimento devolvidos corresponderão aos pontos de código Unicode. Utilize esta opção se a sua aplicação estiver escrita num idioma que suporte Unicode, por exemplo Python.
Utf16CodeUnit	string	Os valores de desvio e comprimento devolvidos corresponderão às unidades de código UTF-16. Utilize esta opção se a sua aplicação estiver escrita num idioma que suporte Unicode, por exemplo Java, JavaScript.

TextAnswer

Representa o resultado da resposta.

Name	Tipo	Description
answer	string	Resposta.
answerSpan	AnswerSpan	Objeto de span de resposta em relação à pergunta do utilizador.
confidenceScore	number	responder classificação de confiança, intervalos de valor de 0 a 1.
id	string	ID de registo.
length	integer	O comprimento da frase.
offset	integer	O desvio da frase desde o início do documento.

TextDocument

Represente o registo de texto de entrada a consultar.

Name	Tipo	Description
id	string	Identificador exclusivo para o registo de texto.
text	string	Conteúdo de texto do registo.

Partilhar via

Question Answering - Get Answers From Text

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

AADToken

Notas

Scopes

Ocp-Apim-Subscription-Key

Exemplos

Successful query

Sample Request

Sample Response

Definições

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Recursos adicionais