Question Answering - Get Answers

Référence

Service:: Cognitive Services

API Version:: 2021-10-01

Répond à la question spécifiée à l’aide de votre base de connaissances.

POST {Endpoint}/language/:query-knowledgebases?projectName={projectName}&deploymentName={deploymentName}&api-version=2021-10-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.
deploymentName	query	True	string	Nom du déploiement spécifique du projet à utiliser.
projectName	query	True	string	Nom du projet à utiliser.

En-tête de la demande

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

Corps de la demande

Nom	Type	Description
answerSpanRequest	ShortAnswerOptions	Pour configurer la fonctionnalité de prédiction de l’étendue de réponse.
confidenceScoreThreshold	number	Score de seuil minimal pour les réponses, plages de valeurs comprises entre 0 et 1.
context	KnowledgeBaseAnswerContext	Objet de contexte avec les informations de QnA précédentes.
filters	QueryFilters	Filtrez les QNA en fonction de la liste de métadonnées et des sources base de connaissances données.
includeUnstructuredSources	boolean	(Facultatif) Indicateur pour activer la requête sur les sources non structurées.
qnaId	integer	ID QnA exact à extraire de l’base de connaissances, ce champ prend la priorité sur la question.
question	string	Question utilisateur à interroger sur le base de connaissances.
rankerType	RankerKind	Type de classement à utiliser.
top	integer	Nombre maximal de réponses à retourner pour la question.
userId	string	Identificateur unique de l’utilisateur.

Réponses

Nom	Type	Description
200 OK	AnswersResult	Réponse réussie pour obtenir des réponses de base de connaissances.
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exemples

Successful query

Sample Request

HTTP

POST {Endpoint}/language/:query-knowledgebases?projectName=proj1&deploymentName=production&api-version=2021-10-01


{
  "question": "how long it takes to charge surface?",
  "top": 3,
  "userId": "sd53lsY=",
  "confidenceScoreThreshold": 0.2,
  "context": {
    "previousQnaId": 9,
    "previousUserQuery": "Where are QnA Maker quickstarts?"
  },
  "rankerType": "Default",
  "filters": {
    "metadataFilter": {
      "metadata": [
        {
          "key": "category",
          "value": "api"
        },
        {
          "key": "editorial",
          "value": "chitchat"
        }
      ],
      "logicalOperation": "AND"
    },
    "sourceFilter": [
      "filename1.pdf",
      "https://www.wikipedia.org/microsoft"
    ],
    "logicalOperation": "AND"
  },
  "answerSpanRequest": {
    "enable": true,
    "confidenceScoreThreshold": 0.2,
    "topAnswersWithSpan": 1
  },
  "includeUnstructuredSources": true
}

Sample Response

Status code:: 200

{
  "answers": [
    {
      "questions": [
        "Power and charging"
      ],
      "answer": "Power and charging**\n\nIt 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.\n\nYou 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.",
      "confidenceScore": 0.65,
      "id": 20,
      "source": "surface-pro-4-user-guide-EN.pdf",
      "metadata": {
        "category": "api",
        "editorial": "chitchat"
      },
      "dialog": {
        "isContextOnly": false,
        "prompts": [
          {
            "displayOrder": 1,
            "qnaId": 23,
            "displayText": "prompt1"
          },
          {
            "displayOrder": 2,
            "qnaId": 36,
            "displayText": "prompt2"
          }
        ]
      },
      "answerSpan": {
        "text": "two to four hours",
        "confidenceScore": 0.3,
        "offset": 33,
        "length": 50
      }
    },
    {
      "questions": [
        "Charge your Surface Pro 4"
      ],
      "answer": "**Charge your Surface Pro 4**\n\n1.  Connect the two parts of the power cord.\n\n2.  Connect the power cord securely to the charging port.\n\n3.  Plug the power supply into an electrical outlet.",
      "confidenceScore": 0.32,
      "id": 13,
      "source": "surface-pro-4-user-guide-EN.pdf"
    }
  ]
}

Définitions

Nom	Description
AnswersOptions	Paramètres pour interroger un base de connaissances.
AnswerSpan	Objet d’étendue de réponse de QnA.
AnswersResult	Représente la liste des réponses aux questions.
enable	Activez ou désactivez la prédiction de l’étendue de réponse.
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.
KnowledgeBaseAnswer	Représente base de connaissances réponse.
KnowledgeBaseAnswerContext	Objet de contexte avec les informations de QnA précédentes.
KnowledgeBaseAnswerDialog	Boîte de dialogue associée à La réponse.
KnowledgeBaseAnswerPrompt	Demander une réponse.
LogicalOperationKind	Définissez sur « OR » ou « AND » pour l’utilisation de l’opération logique correspondante.
MetadataFilter	Recherchez des QNA qui sont associés à la liste de métadonnées donnée.
MetadataRecord	Objet pour fournir la paire de valeurs de clé pour chaque métadonnées.
QueryFilters	filtre sur base de connaissances.
RankerKind	Type de classement à utiliser.
ShortAnswerOptions	Pour configurer la fonctionnalité de prédiction de l’étendue de réponse.

AnswersOptions

Paramètres pour interroger un base de connaissances.

Nom	Type	Description
answerSpanRequest	ShortAnswerOptions	Pour configurer la fonctionnalité de prédiction de l’étendue de réponse.
confidenceScoreThreshold	number	Score de seuil minimal pour les réponses, plages de valeurs comprises entre 0 et 1.
context	KnowledgeBaseAnswerContext	Objet de contexte avec les informations de QnA précédentes.
filters	QueryFilters	Filtrez les QNA en fonction de la liste de métadonnées et des sources base de connaissances données.
includeUnstructuredSources	boolean	(Facultatif) Indicateur pour activer la requête sur les sources non structurées.
qnaId	integer	ID QnA exact à extraire de l’base de connaissances, ce champ prend la priorité sur la question.
question	string	Question utilisateur à interroger sur le base de connaissances.
rankerType	RankerKind	Type de classement à utiliser.
top	integer	Nombre maximal de réponses à retourner pour la question.
userId	string	Identificateur unique de l’utilisateur.

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.

AnswersResult

Représente la liste des réponses aux questions.

Nom	Type	Description
answers	KnowledgeBaseAnswer[]	Représente la liste des résultats de la réponse.

enable

Activez ou désactivez la prédiction de l’étendue de réponse.

Nom	Type	Description
True	Boolean

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
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	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
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	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.

KnowledgeBaseAnswer

Représente base de connaissances réponse.

Nom	Type	Description
answer	string	Texte de réponse.
answerSpan	AnswerSpan	Objet d’étendue de réponse de QnA en ce qui concerne la question de l’utilisateur.
confidenceScore	number	Score de confiance de réponse, plages de valeurs comprises entre 0 et 1.
dialog	KnowledgeBaseAnswerDialog	Boîte de dialogue associée à La réponse.
id	integer	ID du résultat QnA.
metadata	object	Métadonnées associées à la réponse, utiles pour catégoriser ou filtrer les réponses aux questions.
questions	string[]	Liste de questions associées à la réponse.
source	string	Source du résultat QnA.

KnowledgeBaseAnswerContext

Objet de contexte avec les informations de QnA précédentes.

Nom	Type	Description
previousQnaId	integer	ID QnA du résultat du tour précédent.
previousUserQuery	string	Requête utilisateur précédente.

KnowledgeBaseAnswerDialog

Boîte de dialogue associée à La réponse.

Nom	Type	Description
isContextOnly	boolean	Pour marquer si une invite est pertinente uniquement avec une question précédente ou non. Si la valeur est true, n’incluez pas ce QnA comme résultat de recherche pour les requêtes sans contexte ; sinon, si la valeur est false, ignore le contexte et inclut ce QnA dans le résultat de la recherche.
prompts	KnowledgeBaseAnswerPrompt[]	Liste des invites associées à la réponse.

KnowledgeBaseAnswerPrompt

Demander une réponse.

Nom	Type	Description
displayOrder	integer	Index de l’invite : utilisé dans l’ordre des invites.
displayText	string	Texte affiché pour représenter une invite de questions de suivi.
qnaId	integer	ID QnA correspondant à l’invite.

LogicalOperationKind

Définissez sur « OR » ou « AND » pour l’utilisation de l’opération logique correspondante.

Nom	Type	Description
AND	string
OR	string

MetadataFilter

Recherchez des QNA qui sont associés à la liste de métadonnées donnée.

Nom	Type	Valeur par défaut	Description
logicalOperation	LogicalOperationKind	AND	Opération utilisée pour joindre des filtres de métadonnées.
metadata	MetadataRecord[]		Objet pour fournir la paire de valeurs de clé pour chaque métadonnées.

MetadataRecord

Objet pour fournir la paire de valeurs de clé pour chaque métadonnées.

Nom	Type	Description
key	string	Clé de métadonnées du dictionnaire de métadonnées utilisé dans le QnA.
value	string	Valeur des métadonnées du dictionnaire de métadonnées utilisé dans le QnA.

QueryFilters

filtre sur base de connaissances.

Nom	Type	Valeur par défaut	Description
logicalOperation	LogicalOperationKind	AND	Opération logique utilisée pour joindre le filtre de métadonnées avec le filtre source.
metadataFilter	MetadataFilter		Recherchez des QNA qui sont associés à la liste de métadonnées donnée.
sourceFilter	string[]		Recherchez des QNA qui sont associés à l’une des sources données dans base de connaissances.

RankerKind

Type de classement à utiliser.

Nom	Type	Description
Default	string	Classement par défaut.
QuestionOnly	string	Question uniquement ranker.

ShortAnswerOptions

Pour configurer la fonctionnalité de prédiction de l’étendue de réponse.

Nom	Type	Description
confidenceScoreThreshold	number	Score de seuil minimal requis pour inclure une étendue de réponse, des plages de valeurs comprises entre 0 et 1.
enable	enable	Activez ou désactivez la prédiction de l’étendue de réponse.
topAnswersWithSpan	integer	Nombre de réponses principales à prendre en compte pour la prédiction d’étendue comprise entre 1 et 10.

Share via