Question Answering - Get Answers

Referencia

Service:: Cognitive Services - Language

API Version:: 2023-04-01

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

POST {Endpoint}/language/:query-knowledgebases?projectName={projectName}&deploymentName={deploymentName}&api-version=2023-04-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 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 lehet.
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ő) Jelző a nem strukturált forrásokon keresztüli lekérdezés engedélyezéséhez.
qnaId	integer	A tudásbázis lekérendő pontos QnA-azonosító, ez a mező elsőbbséget élvez a kérdésnél.
question	string	A tudásbázis lekérdezésére vonatkozó felhasználói kérdés.
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 az tudásbázis válaszaihoz.
Other Status Codes	ErrorResponse	Hibaválasz.

Biztonság

AADToken

Ezek az Azure Active Directory OAuth2-folyamatok . Az Azure-beli szerepköralapú hozzáférés-vezérléssel párosítva Azure Maps REST API-khoz való hozzáférés vezérlésére használható. Az Azure szerepköralapú hozzáférés-vezérlése egy vagy több Azure Maps erőforrásfiókhoz vagy alerőforráshoz való hozzáférés kijelölésére szolgál. Bármely felhasználó, csoport vagy szolgáltatásnév hozzáférést kaphat egy beépített szerepkörrel vagy egy vagy több rest API-Azure Maps ra vonatkozó engedélyből álló egyéni szerepkörrel.

A forgatókönyvek implementálásához javasoljuk, hogy tekintse meg a hitelesítési fogalmakat. Összefoglalva, ez a biztonsági definíció megoldást nyújt az alkalmazás(ok) adott API-k és hatókörök hozzáférés-vezérlésére képes objektumokon keresztüli modellezésére.

Jegyzetek

Ez a biztonsági definíció megköveteli a fejléc használatát annak x-ms-client-id jelzéséhez, hogy melyik Azure Maps erőforráshoz kér hozzáférést az alkalmazás. Ez a Maps management API-ból szerezhető be.

A Authorization URL az Azure nyilvános felhőpéldányára vonatkozik. A szuverén felhők egyedi engedélyezési URL-címekkel és Azure Active Directory-konfigurációkkal rendelkeznek. * Az Azure szerepköralapú hozzáférés-vezérlése az Azure felügyeleti síkjáról van konfigurálva Azure Portal, PowerShell, CLI, Azure SDK-k vagy REST API-k használatával. * A Azure Maps Web SDK használata lehetővé teszi az alkalmazások konfigurációalapú beállítását több használati esetben.

Jelenleg az Azure Active Directory 1.0-s vagy 2.0-s verziója támogatja a Munkahelyi, iskolai és vendégfelhasználói verziót, de nem támogatja a személyes fiókokat.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

Egy language service-erőforrás előfizetési kulcsa.

Type: apiKey
In: header

Példák

Successful query

Sample Request

HTTP

POST {Endpoint}/language/:query-knowledgebases?projectName=proj1&deploymentName=production&api-version=2023-04-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 answer 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 pontosabb információkat tartalmaz a hibáról. A Microsoft One API irányelveinek megfelelően : 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	A megfelelő logikai művelet használatához állítsa az "OR" vagy az "AND" értéket.
MetadataFilter	Keresse meg az adott metaadatok listájához társított QNA-kat.
MetadataRecord	Objektum az egyes metaadatok kulcsértékpárjának megadásához.
QueryFilters	szűrőt 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 lehet.
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ő) Jelző a nem strukturált forrásokon keresztüli lekérdezés engedélyezéséhez.
qnaId	integer	A tudásbázis lekérendő pontos QnA-azonosító, ez a mező elsőbbséget élvez a kérdésnél.
question	string	A tudásbázis lekérdezésére vonatkozó felhasználói kérdés.
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 answer span objektuma.

Name	Típus	Description
confidenceScore	number	A választartomány előrejelzett pontszáma, az érték 0 és 1 között mozog.
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álaszeredmények 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ót 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
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

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

Egy objektum, amely pontosabb információkat tartalmaz a hibáról. A Microsoft One API irányelveinek megfelelően : 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ót 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övege.
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, az érték 0 és 1 között mozog.
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, amelyek hasznosak a kérdésválaszok kategorizálásához vagy szűréséhez.
questions	string[]	A válaszhoz kapcsolódó 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ésre vonatkozik-e, vagy sem. Ha igaz, ne foglalja bele ezt a QnA-t a környezet nélküli lekérdezések keresési eredményébe; ellenkező esetben, ha hamis, figyelmen kívül hagyja a kontextust, és belefogadja ezt a QnA-t a keresési eredménybe.
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

A megfelelő logikai művelet használatához állítsa az "OR" vagy az "AND" értéket.

Name	Típus	Description
AND	string
OR	string

MetadataFilter

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

Name	Típus	Alapértelmezett érték	Description
logicalOperation	LogicalOperationKind	AND	Metaadatszű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	A QnA-ban használt metaadat-szótár metaadatkulcsa.
value	string	Metaadat-érték a QnA-ban használt metaadat-szótárból.

QueryFilters

szűrőt tudásbázis.

Name	Típus	Alapértelmezett érték	Description
logicalOperation	LogicalOperationKind	AND	A metaadatszűrő forrásszűrővel való összekapcsolására szolgáló logikai művelet.
metadataFilter	MetadataFilter		Keresse meg az adott metaadatok listájához társított QNA-kat.
sourceFilter	string[]		Keresse meg azokat a QNA-kat, amelyek a tudásbázis adott forráslistájához vannak társítva.

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 belefoglalásához minimális küszöbérték szükséges, az érték 0 és 1 között lehet.
enable	enable	Az Answer Span előrejelzésének engedélyezése vagy letiltása.
topAnswersWithSpan	integer	Az 1 és 10 közötti span-előrejelzéshez figyelembe vehető leggyakoribb válaszok száma.

Megosztás a következőn keresztül: