Question Answering - Get Answers From Text

Referência

Serviço:: Cognitive Services - Language

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	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Versão de API do cliente.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
question	True	string	Pergunta do usuário para consultar nos 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 mais informações, consulte https://aka.ms/text-analytics-offsets.

Respostas

Nome	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

Esses são os Fluxos OAuth2 do Azure Active Directory . Quando emparelhado com o controle de acesso baseado em função do Azure, ele pode ser usado para controlar o acesso às APIs REST Azure Mapas. Os controles de acesso baseados em função do Azure são usados para designar o acesso a uma ou mais Azure Mapas conta de recurso ou sub-recursos. Qualquer usuário, grupo ou entidade de serviço pode receber acesso por meio de uma função interna ou uma função personalizada composta por uma ou mais permissões para Azure Mapas APIs REST.

Para implementar cenários, recomendamos exibir conceitos de autenticação. Em resumo, essa definição de segurança fornece uma solução para modelar aplicativos por meio de objetos capazes de acessar o controle em APIs e escopos específicos.

Observações

Essa definição de segurança requer o uso do x-ms-client-id cabeçalho para indicar a qual Azure Mapas recurso ao qual o aplicativo está solicitando acesso. Isso pode ser adquirido da API de gerenciamento de Mapas.

O Authorization URL é específico para a instância de nuvem pública do Azure. As nuvens soberanas têm URLs de autorização exclusivas e configurações do Azure Active Directory. * O controle de acesso baseado em função do Azure é configurado no plano de gerenciamento do Azure por meio de portal do Azure, PowerShell, CLI, SDKs do Azure ou APIs REST. * O uso do SDK da Web Azure Mapas permite a configuração baseada em configuração de um aplicativo para vários casos de uso.

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

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

Escopos

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

Ocp-Apim-Subscription-Key

Uma chave de assinatura para um recurso de serviço de linguagem.

Tipo: apiKey
Em: header

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.",
      "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

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 de QnA.
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.
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 mais informações, 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

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 nos 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 mais informações, consulte https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Representa os resultados da resposta.

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

AnswerSpan

Objeto de intervalo de resposta de QnA.

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

Error

O objeto de erro.

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 homem do erro.
target	string	O destino do erro.

ErrorCode

Código de erro legível por humanos.

Nome	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.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Código de erro legível por humanos.

Nome	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 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 do erro.

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 mais informações, consulte https://aka.ms/text-analytics-offsets.

Nome	Tipo	Description
TextElements_v8	string	Os valores de deslocamento e comprimento retornados corresponderão a TextElements (clusters Graphemes e Grapheme) confirmando para o padrão Unicode 8.0.0. Use essa opção se o aplicativo for escrito no .Net Framework ou .Net Core e você usará StringInfo.
UnicodeCodePoint	string	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 a Unicode, por exemplo, Python.
Utf16CodeUnit	string	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 a Unicode, por exemplo Java, JavaScript.

TextAnswer

Representa o resultado da resposta.

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

TextDocument

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

AADToken

Observações

Escopos

Ocp-Apim-Subscription-Key

Exemplos

Successful query

Solicitação de exemplo

Resposta de exemplo

Definições

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Recursos adicionais