Prebuilt - Generate Answer

Referência

Serviço:: Azure AI Services

Versão da API:: v5.0-preview.2

GenerateAnswer chama para consultar texto em documentos.

POST {Endpoint}/qnamaker/v5.0-preview.2/generateAnswer

Com parâmetros opcionais:

POST {Endpoint}/qnamaker/v5.0-preview.2/generateAnswer?stringIndexType={stringIndexType}

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://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
stringIndexType	query		string	(Opcional) 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.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
documents	True	TextInput[]	Documentos a serem pesquisados para determinada pergunta.
question	True	string	Pergunta do usuário para consultar nos documentos especificados.
language		string minLength: 2 maxLength: 100	(Opcional) Idioma dos documentos. Esta é a representação ISO 639-1 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.

Respostas

Nome	Tipo	Description
200 OK	GenerateAnswerBatchResultItem[]	Resposta de chamada do GenerateAnswer predefinida.
Other Status Codes	ErrorResponse	Resposta de erro.

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

Exemplos

Successful query

Solicitação de exemplo

HTTP

POST {Endpoint}/qnamaker/v5.0-preview.2/generateAnswer


{
  "question": "qna maker and luis",
  "documents": [
    {
      "text": "Graphics  Surprise, surprise -- our 4K Envy 13 came with a discrete graphics card. While the Nvidia GeForce MX250 GPU isn't meant for demanding gaming",
      "id": "1"
    },
    {
      "text": "Graphics  Surprise, surprise -- our 4K Envy 13 came with a discrete graphics card. While the Nvidia GeForce MX250 GPU isn't meant for demanding gaming",
      "id": "2"
    }
  ],
  "language": "en"
}

Resposta de exemplo

Código de status:: 200

{
  "answers": [
    {
      "answer": "Graphics  Surprise, surprise -- our 4K Envy 13 came with a discrete graphics card. While the Nvidia GeForce MX250 GPU isn't meant for demanding gaming, it is a step up from integrated graphics as proven by comparing it to the UHD 620 GPU in the FHD model.",
      "answerSpan": {
        "endIndex": 82,
        "startIndex": 60,
        "text": "discrete graphics card",
        "score": 0
      },
      "answerEndIndex": 655,
      "answerStartIndex": 0,
      "id": 1,
      "score": 100
    }
  ]
}

Definições

Nome	Description
AnswerSpan	Objeto de intervalo de resposta do QnA em relação à pergunta do usuário.
Error	O objeto de 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.
ErrorCodeType	Um de um conjunto definido pelo servidor de códigos de erro.
ErrorResponse	Resposta de 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.
GenerateAnswerBatchResultItem	Representa o resultado da resposta predefinido.
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.
PrebuiltQuery	Esquema de corpo POST para consultar os documentos por meio de Resposta a Perguntas Predefinidas.
TextInput	Lista de documentos a serem consultados.

AnswerSpan

Objeto

Objeto de intervalo de resposta do QnA em relação à pergunta do usuário.

Nome	Tipo	Description
endIndex	integer (int32)	Índice final do intervalo de respostas em resposta.
score	number (double)	Pontuação prevista de intervalo de respostas.
startIndex	integer (int32)	Inicie o índice de intervalo de respostas em resposta.
text	string	Texto previsto do intervalo de respostas.

Error

Objeto

O objeto de 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	ErrorCodeType	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.

ErrorCodeType

Enumeração

Um de um conjunto definido pelo servidor de códigos de erro.

Valor	Description
BadArgument
EndpointKeysError
ExtractionFailure
Forbidden
KbNotFound
NotFound
OperationNotFound
QnaRuntimeError
QuotaExceeded
SKULimitExceeded
ServiceError
Unauthorized
Unspecified
ValidationFailure

ErrorResponse

Objeto

Resposta de 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
error	Error	O objeto de erro.

GenerateAnswerBatchResultItem

Objeto

Representa o resultado da resposta predefinido.

Nome	Tipo	Description
answer	string	Responder.
answerEndIndex	integer (int32)	Índice final de resposta no texto do documento.
answerSpan	AnswerSpan	Objeto de intervalo de resposta em relação à pergunta do usuário.
answerStartIndex	integer (int32)	Inicie o índice de resposta no texto do documento.
id	string	ID do documento.
score	number	Pontuação do resultado da pesquisa.

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	string	Um código de erro mais específico do que foi fornecido pelo erro que contém.
innerError	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.

PrebuiltQuery

Objeto

Esquema de corpo POST para consultar os documentos por meio de Resposta a Perguntas Predefinidas.

Nome	Tipo	Description
documents	TextInput[]	Documentos a serem pesquisados para determinada pergunta.
language	string minLength: 2 maxLength: 100	(Opcional) Idioma dos documentos. Esta é a representação ISO 639-1 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 documentos especificados.

TextInput

Objeto

Lista de documentos a serem consultados.

Nome	Tipo	Description
id	string	Identificador exclusivo do documento.
text	string	Conteúdo de texto do documento

Compartilhar via

Prebuilt - Generate Answer

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Successful query

Solicitação de exemplo

Resposta de exemplo

Definições

AnswerSpan

Error

ErrorCodeType

ErrorResponse

GenerateAnswerBatchResultItem

InnerErrorModel

PrebuiltQuery

TextInput