Question Answering - Get Answers From Text

Référence

Service:: Cognitive Services - Language

Version d'API:: 2023-04-01

Répond à la question spécifiée à l’aide du texte fourni dans le corps.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge (par exemple, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Version d’API client.

Corps de la demande

Nom	Obligatoire	Type	Description
question	True	string	Question de l’utilisateur pour interroger les enregistrements de texte donnés.
records	True	TextDocument[]	Enregistrements de texte à rechercher pour une question donnée.
language		string	Langue des enregistrements de texte. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour espagnol, etc. Si ce n’est pas défini, utilisez « en » pour l’anglais comme valeur par défaut.
stringIndexType		StringIndexType	Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Par défaut, les éléments de texte (Graphèmes) sont conformes à Unicode v8.0.0. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.

Réponses

Nom	Type	Description
200 OK	AnswersFromTextResult	Réponse réussie pour obtenir des réponses à partir du texte d’entrée.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

AADToken

Il s’agit des flux OAuth2 Azure Active Directory . Lorsqu’il est associé au contrôle d’accès en fonction du rôle Azure, il peut être utilisé pour contrôler l’accès à Azure Maps API REST. Les contrôles d’accès en fonction du rôle Azure sont utilisés pour désigner l’accès à un ou plusieurs Azure Maps compte de ressources ou sous-ressources. Tout utilisateur, groupe ou principal de service peut se voir accorder l’accès via un rôle intégré ou un rôle personnalisé composé d’une ou plusieurs autorisations pour Azure Maps API REST.

Pour implémenter des scénarios, nous vous recommandons d’afficher les concepts d’authentification. En résumé, cette définition de sécurité fournit une solution pour modéliser des applications via des objets capables de contrôler l’accès sur des API et des étendues spécifiques.

Notes

Cette définition de sécurité nécessite l’utilisation de l’en-tête x-ms-client-id pour indiquer à quelle ressource Azure Maps l’application demande l’accès. Vous pouvez l’acquérir à partir de l’API de gestion Maps.

Authorization URL est spécifique au cloud public Azure instance. Les clouds souverains ont des URL d’autorisation uniques et des configurations Azure Active directory. * Le contrôle d’accès en fonction du rôle Azure est configuré à partir du plan de gestion Azure via Portail Azure, PowerShell, CLI, sdk Azure ou API REST. * L’utilisation du Kit de développement logiciel (SDK) web Azure Maps permet une configuration basée sur la configuration d’une application pour plusieurs cas d’usage.

Actuellement, Azure Active Directory v1.0 ou v2.0 prend en charge les comptes professionnels, scolaires et invités, mais ne prend pas en charge les comptes personnels.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Ocp-Apim-Subscription-Key

Clé d’abonnement pour une ressource de service Language.

Type: apiKey
Dans: header

Exemples

Successful query

Exemple de requête

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

Exemple de réponse

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

Définitions

Nom	Description
AnswersFromTextOptions	Paramètres d’enregistrement de la question et du texte à répondre.
AnswersFromTextResult	Représente les résultats de la réponse.
AnswerSpan	Objet d’étendue de réponse de QnA.
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’utilisateur.
ErrorResponse	Réponse d’erreur.
InnerErrorCode	Code d’erreur lisible par l’utilisateur.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions relatives à l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
StringIndexType	Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Par défaut, les éléments de texte (Graphèmes) sont conformes à Unicode v8.0.0. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.
TextAnswer	Représente le résultat de la réponse.
TextDocument	Représenter l’enregistrement de texte d’entrée à interroger.

AnswersFromTextOptions

Paramètres d’enregistrement de la question et du texte à répondre.

Nom	Type	Valeur par défaut	Description
language	string		Langue des enregistrements de texte. Il s’agit de la représentation BCP-47 d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour espagnol, etc. Si ce n’est pas défini, utilisez « en » pour l’anglais comme valeur par défaut.
question	string		Question de l’utilisateur pour interroger les enregistrements de texte donnés.
records	TextDocument[]		Enregistrements de texte à rechercher pour une question donnée.
stringIndexType	StringIndexType	TextElements_v8	Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Par défaut, les éléments de texte (Graphèmes) sont conformes à Unicode v8.0.0. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.

AnswersFromTextResult

Représente les résultats de la réponse.

Nom	Type	Description
answers	TextAnswer[]	Représente les résultats de la réponse.

AnswerSpan

Objet d’étendue de réponse de QnA.

Nom	Type	Description
confidenceScore	number	Score prédit de l’étendue de réponse, plages de valeurs comprises entre 0 et 1.
length	integer	Longueur de l’étendue de réponse.
offset	integer	Décalage de l’étendue de réponse par rapport au début de la réponse.
text	string	Texte prédit de l’étendue de réponse.

Error

Objet d’erreur.

Nom	Type	Description
code	ErrorCode	Un des codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur les 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.

ErrorCode

Code d’erreur lisible par l’utilisateur.

Nom	Type	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

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

InnerErrorCode

Code d’erreur lisible par l’utilisateur.

Nom	Type	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

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

Nom	Type	Description
code	InnerErrorCode	Un des codes d’erreur définis par le serveur.
details	object	Détails de l’erreur.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

StringIndexType

Spécifie la méthode utilisée pour interpréter les décalages de chaîne. Par défaut, les éléments de texte (Graphèmes) sont conformes à Unicode v8.0.0. Pour plus d’informations, consultez https://aka.ms/text-analytics-offsets.

Nom	Type	Description
TextElements_v8	string	Les valeurs de décalage et de longueur retournées correspondent à TextElements (clusters Graphemes et Grapheme) confirmant la norme Unicode 8.0.0. Utilisez cette option si votre application est écrite dans .Net Framework ou .Net Core et que vous allez utiliser StringInfo.
UnicodeCodePoint	string	Les valeurs de décalage et de longueur retournées correspondent aux points de code Unicode. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple Python.
Utf16CodeUnit	string	Les valeurs de décalage et de longueur retournées correspondent aux unités de code UTF-16. Utilisez cette option si votre application est écrite dans un langage qui prend en charge Unicode, par exemple Java, JavaScript.

TextAnswer

Représente le résultat de la réponse.

Nom	Type	Description
answer	string	Réponse.
answerSpan	AnswerSpan	Objet d’étendue de réponse par rapport à la question de l’utilisateur.
confidenceScore	number	score de confiance de réponse, plages de valeurs comprises entre 0 et 1.
id	string	ID d’enregistrement.
length	integer	Longueur de la phrase.
offset	integer	Décalage de phrase à partir du début du document.

TextDocument

Représenter l’enregistrement de texte d’entrée à interroger.

Nom	Type	Description
id	string	Identificateur unique pour l’enregistrement texte.
text	string	Contenu textuel de l’enregistrement.

Partager via

Question Answering - Get Answers From Text

Paramètres URI

Corps de la demande

Réponses

Sécurité

AADToken

Notes

Étendues

Ocp-Apim-Subscription-Key

Exemples

Successful query

Exemple de requête

Exemple de réponse

Définitions

AnswersFromTextOptions

AnswersFromTextResult

AnswerSpan

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

StringIndexType

TextAnswer

TextDocument

Ressources supplémentaires