Question Answering - Get Answers

Referencia

Service:: Cognitive Services

API Version:: 2021-10-01

A megadott kérdésre a tudásbázis választ ad.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
Endpoint	path	True	string	Támogatott Cognitive Services-végpont (pl. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Ügyfél API-verziója.
deploymentName	query	True	string	A használni kívánt projekt adott üzembe helyezésének neve.
projectName	query	True	string	A használni kívánt projekt neve.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string

Kérelem törzse

Name	Típus	Description
answerSpanRequest	ShortAnswerOptions	Az Answer span előrejelzési funkció konfigurálása.
confidenceScoreThreshold	number	A válaszok minimális küszöbértéke, az érték 0 és 1 között van.
context	KnowledgeBaseAnswerContext	Környezeti objektum az előző QnA-adatokkal.
filters	QueryFilters	A QNA-k szűrése adott metaadatlista és tudásbázis források alapján.
includeUnstructuredSources	boolean	(Nem kötelező) Jelölő a nem strukturált forrásokon keresztüli lekérdezés engedélyezéséhez.
qnaId	integer	Pontos QnA-azonosító a tudásbázis lekéréséhez, ez a mező elsőbbséget élvez a kérdésnél.
question	string	Felhasználói kérdés a tudásbázis lekérdezéséhez.
rankerType	RankerKind	A használni kívánt rangsoroló típusa.
top	integer	A kérdésre visszaadandó válaszok maximális száma.
userId	string	A felhasználó egyedi azonosítója.

Válaszok

Name	Típus	Description
200 OK	AnswersResult	Sikeres válasz a tudásbázis válaszok lekéréséhez.
Other Status Codes	ErrorResponse	Hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Példák

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

Definíciók

Name	Description
AnswersOptions	Paraméterek egy tudásbázis lekérdezéséhez.
AnswerSpan	A QnA válasz span objektuma.
AnswersResult	A kérdésekre adott válaszok listáját jelöli.
enable	Az Answer Span előrejelzésének engedélyezése vagy letiltása.
Error	A hibaobjektum.
ErrorCode	Emberi olvasásra alkalmas hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Emberi olvasásra alkalmas hibakód.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KnowledgeBaseAnswer	Tudásbázis választ jelöli.
KnowledgeBaseAnswerContext	Környezeti objektum az előző QnA-adatokkal.
KnowledgeBaseAnswerDialog	A Válaszhoz társított párbeszédpanel.
KnowledgeBaseAnswerPrompt	Válasz kérése.
LogicalOperationKind	Állítsa "VAGY" vagy "AND" értékre a megfelelő logikai művelet használatához.
MetadataFilter	Keresse meg a metaadatok adott listájához társított QNA-kat.
MetadataRecord	Objektum az egyes metaadatok kulcsértékpárjának megadásához.
QueryFilters	szűrőket tudásbázis.
RankerKind	A használni kívánt rangsoroló típusa.
ShortAnswerOptions	Az Answer span előrejelzési funkció konfigurálása.

AnswersOptions

Paraméterek egy tudásbázis lekérdezéséhez.

Name	Típus	Description
answerSpanRequest	ShortAnswerOptions	Az Answer span előrejelzési funkció konfigurálása.
confidenceScoreThreshold	number	A válaszok minimális küszöbértéke, az érték 0 és 1 között van.
context	KnowledgeBaseAnswerContext	Környezeti objektum az előző QnA-adatokkal.
filters	QueryFilters	A QNA-k szűrése adott metaadatlista és tudásbázis források alapján.
includeUnstructuredSources	boolean	(Nem kötelező) Jelölő a nem strukturált forrásokon keresztüli lekérdezés engedélyezéséhez.
qnaId	integer	Pontos QnA-azonosító a tudásbázis lekéréséhez, ez a mező elsőbbséget élvez a kérdésnél.
question	string	Felhasználói kérdés a tudásbázis lekérdezéséhez.
rankerType	RankerKind	A használni kívánt rangsoroló típusa.
top	integer	A kérdésre visszaadandó válaszok maximális száma.
userId	string	A felhasználó egyedi azonosítója.

AnswerSpan

A QnA válasz span objektuma.

Name	Típus	Description
confidenceScore	number	A választartomány előrejelzett pontszáma, az értéktartomány 0 és 1 között van.
length	integer	A választartomány hossza.
offset	integer	A válasz eltolódása a válasz kezdetétől.
text	string	A választartomány előrejelzett szövege.

AnswersResult

A kérdésekre adott válaszok listáját jelöli.

Name	Típus	Description
answers	KnowledgeBaseAnswer[]	A Válasz eredménye listát jelöli.

enable

Az Answer Span előrejelzésének engedélyezése vagy letiltása.

Name	Típus	Description
True	Boolean

Error

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorCode

Emberi olvasásra alkalmas hibakód.

Name	Típus	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

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode

Emberi olvasásra alkalmas hibakód.

Name	Típus	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

KnowledgeBaseAnswer

Tudásbázis választ jelöli.

Name	Típus	Description
answer	string	Válasz szöveg.
answerSpan	AnswerSpan	Válasz a QnA objektumára a felhasználó kérdésére vonatkozóan.
confidenceScore	number	Válasz megbízhatósági pontszáma, értéktartományok 0 és 1 között.
dialog	KnowledgeBaseAnswerDialog	A Válaszhoz társított párbeszédpanel.
id	integer	A QnA-eredmény azonosítója.
metadata	object	A válaszhoz társított metaadatok hasznosak a kérdések válaszainak kategorizálásához vagy szűréséhez.
questions	string[]	A válaszhoz társított kérdések listája.
source	string	A QnA-eredmény forrása.

KnowledgeBaseAnswerContext

Környezeti objektum az előző QnA-adatokkal.

Name	Típus	Description
previousQnaId	integer	Előző turn top answer result QnA ID.
previousUserQuery	string	Előző felhasználói lekérdezés.

KnowledgeBaseAnswerDialog

A Válaszhoz társított párbeszédpanel.

Name	Típus	Description
isContextOnly	boolean	Annak megjelölése, hogy egy kérdés csak egy korábbi kérdés esetén releváns-e, vagy sem. Ha igaz, ne adja meg ezt a QnA-t a környezet nélküli lekérdezések keresési eredményeként; ellenkező esetben, ha hamis, figyelmen kívül hagyja a kontextust, és ezt a QnA-t tartalmazza a keresési eredményben.
prompts	KnowledgeBaseAnswerPrompt[]	A válaszhoz társított kérések listája.

KnowledgeBaseAnswerPrompt

Válasz kérése.

Name	Típus	Description
displayOrder	integer	A parancssor indexe – a parancssorok sorrendjében használatos.
displayText	string	A következő kérdés megválaszolására megjelenő szöveg.
qnaId	integer	A kérdésnek megfelelő QnA-azonosító.

LogicalOperationKind

Állítsa "VAGY" vagy "AND" értékre a megfelelő logikai művelet használatához.

Name	Típus	Description
AND	string
OR	string

MetadataFilter

Keresse meg a metaadatok adott listájához társított QNA-kat.

Name	Típus	Alapértelmezett érték	Description
logicalOperation	LogicalOperationKind	AND	Metaadat-szűrők összekapcsolására használt művelet.
metadata	MetadataRecord[]		Objektum az egyes metaadatok kulcsértékpárjának megadásához.

MetadataRecord

Objektum az egyes metaadatok kulcsértékpárjának megadásához.

Name	Típus	Description
key	string	Metaadat-kulcs a QnA-ban használt metaadat-szótárból.
value	string	Metaadat-érték a QnA-ban használt metaadat-szótárból.

QueryFilters

szűrőket tudásbázis.

Name	Típus	Alapértelmezett érték	Description
logicalOperation	LogicalOperationKind	AND	Logikai művelet a metaadat-szűrő forrásszűrővel való összekapcsolásához.
metadataFilter	MetadataFilter		Keresse meg a metaadatok adott listájához társított QNA-kat.
sourceFilter	string[]		Keresse meg a tudásbázis adott forráslistájához társított QNA-kat.

RankerKind

A használni kívánt rangsoroló típusa.

Name	Típus	Description
Default	string	Alapértelmezett rangsoroló.
QuestionOnly	string	Kérdés csak rangsoroló.

ShortAnswerOptions

Az Answer span előrejelzési funkció konfigurálása.

Name	Típus	Description
confidenceScoreThreshold	number	A választartomány megadásához minimális küszöbérték szükséges, az érték 0 és 1 között van.
enable	enable	Az Answer Span előrejelzésének engedélyezése vagy letiltása.
topAnswersWithSpan	integer	Az 1-től 10-esig terjedő span-előrejelzéshez figyelembe vehető leggyakoribb válaszok száma.

Share via