Prebuilt - Generate Answer

Référence

Service:: Azure AI Services

Version d'API:: v5.0-preview.2

Appel GenerateAnswer pour interroger du texte dans des documents.

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

Avec des paramètres facultatifs:

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge (par exemple, https://< qnamaker-resource-name >.api.cognitiveservices.azure.com).
stringIndexType	query		string	(Facultatif) Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Valeur par défaut des éléments de texte (Graphemes) en fonction d’Unicode v8.0.0.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Corps de la demande

Nom	Obligatoire	Type	Description
documents	True	TextInput[]	Documents à rechercher pour une question donnée.
question	True	string	Question de l’utilisateur à interroger sur les documents donnés.
language		string minLength: 2 maxLength: 100	(Facultatif) Langue des documents. Il s’agit de la représentation ISO 639-1 d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour l’espagnol, etc. Si ce n’est pas le cas, utilisez « en » pour l’anglais comme valeur par défaut.

Réponses

Nom	Type	Description
200 OK	GenerateAnswerBatchResultItem[]	Réponse d’appel GenerateAnswer prédéfinie.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

Successful query

Exemple de requête

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

Exemple de réponse

Code d’état:: 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
    }
  ]
}

Définitions

Nom	Description
AnswerSpan	Objet d’étendue de réponse de QnA en ce qui concerne la question de l’utilisateur.
Error	Objet d’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ErrorCodeType	Un ensemble de codes d’erreur définis par le serveur.
ErrorResponse	Réponse d’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
GenerateAnswerBatchResultItem	Représente le résultat de réponse prédéfini.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PrebuiltQuery	Schéma du corps POST pour interroger les documents via la réponse aux questions prédéfinies.
TextInput	Liste des documents à interroger.

AnswerSpan

Object

Objet d’étendue de réponse de QnA en ce qui concerne la question de l’utilisateur.

Nom	Type	Description
endIndex	integer (int32)	Index de fin de l’étendue de réponse en réponse.
score	number (double)	Score de réponse prédit.
startIndex	integer (int32)	Démarrez l’index de l’étendue de réponse dans la réponse.
text	string	Texte prédit de l’étendue de réponse.

Error

Object

Objet d’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	ErrorCodeType	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innerError	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorCodeType

Énumération

Un ensemble de codes d’erreur définis par le serveur.

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

ErrorResponse

Object

Réponse d’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
error	Error	Objet d’erreur.

GenerateAnswerBatchResultItem

Object

Représente le résultat de réponse prédéfini.

Nom	Type	Description
answer	string	Répondre.
answerEndIndex	integer (int32)	Index de fin de réponse dans le texte du document.
answerSpan	AnswerSpan	Répondez à l’objet span en ce qui concerne la question de l’utilisateur.
answerStartIndex	integer (int32)	Démarrez l’index de réponse dans le texte du document.
id	string	ID de document.
score	number	Score de résultat de recherche.

InnerErrorModel

Object

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	string	Code d’erreur plus spécifique que fourni par l’erreur contenante.
innerError	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.

PrebuiltQuery

Object

Schéma du corps POST pour interroger les documents via la réponse aux questions prédéfinies.

Nom	Type	Description
documents	TextInput[]	Documents à rechercher pour une question donnée.
language	string minLength: 2 maxLength: 100	(Facultatif) Langue des documents. Il s’agit de la représentation ISO 639-1 d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour l’espagnol, etc. Si ce n’est pas le cas, utilisez « en » pour l’anglais comme valeur par défaut.
question	string	Question de l’utilisateur à interroger sur les documents donnés.

TextInput

Object

Liste des documents à interroger.

Nom	Type	Description
id	string	Identificateur unique du document.
text	string	Contenu texte du document

Partager via

Prebuilt - Generate Answer

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

Ocp-Apim-Subscription-Key

Exemples

Successful query

Exemple de requête

Exemple de réponse

Définitions

AnswerSpan

Error

ErrorCodeType

ErrorResponse

GenerateAnswerBatchResultItem

InnerErrorModel

PrebuiltQuery

TextInput

Ressources supplémentaires