Question Answering - Get Answers

Odwołanie

Service:: Cognitive Services

API Version:: 2021-10-01

Odpowiada na określone pytanie przy użyciu baza wiedzy.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
Endpoint	path	True	string	Obsługiwany punkt końcowy usług Cognitive Services (np. https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Wersja interfejsu API klienta.
deploymentName	query	True	string	Nazwa konkretnego wdrożenia projektu do użycia.
projectName	query	True	string	Nazwa projektu do użycia.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Ocp-Apim-Subscription-Key	True	string

Treść żądania

Nazwa	Typ	Opis
answerSpanRequest	ShortAnswerOptions	Aby skonfigurować funkcję przewidywania zakresu odpowiedzi.
confidenceScoreThreshold	number	Minimalny wynik progu dla odpowiedzi, zakresy wartości z zakresu od 0 do 1.
context	KnowledgeBaseAnswerContext	Obiekt kontekstu z informacjami z poprzednich pytań i pytań i pytań.
filters	QueryFilters	Filtrowanie pytań i pytań na podstawie danej listy metadanych i źródeł baza wiedzy.
includeUnstructuredSources	boolean	(Opcjonalnie) Flaga umożliwiająca włączenie kwerendy dla źródeł bez struktury.
qnaId	integer	Dokładny identyfikator pytań i odpowiedzi do pobrania z baza wiedzy, to pole ma priorytet nad pytaniem.
question	string	Pytanie użytkownika dotyczące zapytania względem baza wiedzy.
rankerType	RankerKind	Typ klasyfikatora do użycia.
top	integer	Maksymalna liczba odpowiedzi, które mają zostać zwrócone na pytanie.
userId	string	Unikatowy identyfikator użytkownika.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AnswersResult	Pomyślna odpowiedź na uzyskanie odpowiedzi z baza wiedzy.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Zabezpieczenia

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Przykłady

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

Definicje

Nazwa	Opis
AnswersOptions	Parametry do wykonywania zapytania o baza wiedzy.
AnswerSpan	Odpowiedź obejmuje obiekt pytań i odpowiedzi.
AnswersResult	Reprezentuje listę odpowiedzi na pytania.
enable	Włączanie lub wyłączanie przewidywania answer span.
Error	Obiekt error.
ErrorCode	Kod błędu czytelny dla człowieka.
ErrorResponse	Odpowiedź na błąd.
InnerErrorCode	Kod błędu czytelny dla człowieka.
InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
KnowledgeBaseAnswer	Reprezentuje odpowiedź baza wiedzy.
KnowledgeBaseAnswerContext	Obiekt kontekstu z informacjami z poprzednich pytań i pytań i pytań.
KnowledgeBaseAnswerDialog	Okno dialogowe skojarzone z odpowiedzią.
KnowledgeBaseAnswerPrompt	Monituj o odpowiedź.
LogicalOperationKind	Ustaw wartość "OR" lub "AND" na potrzeby używania odpowiedniej operacji logicznej.
MetadataFilter	Znajdź pytania i pytania, które są skojarzone z daną listą metadanych.
MetadataRecord	Obiekt zapewniający parę wartości klucza dla każdego metadanych.
QueryFilters	filtrów w baza wiedzy.
RankerKind	Typ klasyfikatora do użycia.
ShortAnswerOptions	Aby skonfigurować funkcję przewidywania zakresu odpowiedzi.

AnswersOptions

Parametry do wykonywania zapytania o baza wiedzy.

Nazwa	Typ	Opis
answerSpanRequest	ShortAnswerOptions	Aby skonfigurować funkcję przewidywania zakresu odpowiedzi.
confidenceScoreThreshold	number	Minimalny wynik progu dla odpowiedzi, zakresy wartości z zakresu od 0 do 1.
context	KnowledgeBaseAnswerContext	Obiekt kontekstu z informacjami z poprzednich pytań i pytań i pytań.
filters	QueryFilters	Filtrowanie pytań i pytań na podstawie danej listy metadanych i źródeł baza wiedzy.
includeUnstructuredSources	boolean	(Opcjonalnie) Flaga umożliwiająca włączenie kwerendy dla źródeł bez struktury.
qnaId	integer	Dokładny identyfikator pytań i odpowiedzi do pobrania z baza wiedzy, to pole ma priorytet nad pytaniem.
question	string	Pytanie użytkownika dotyczące zapytania względem baza wiedzy.
rankerType	RankerKind	Typ klasyfikatora do użycia.
top	integer	Maksymalna liczba odpowiedzi, które mają zostać zwrócone na pytanie.
userId	string	Unikatowy identyfikator użytkownika.

AnswerSpan

Odpowiedź obejmuje obiekt pytań i odpowiedzi.

Nazwa	Typ	Opis
confidenceScore	number	Przewidywany wynik zakresu odpowiedzi, zakresy wartości z zakresu od 0 do 1.
length	integer	Długość zakresu odpowiedzi.
offset	integer	Przesunięcie zakresu odpowiedzi od początku odpowiedzi.
text	string	Przewidywany tekst zakresu odpowiedzi.

AnswersResult

Reprezentuje listę odpowiedzi na pytania.

Nazwa	Typ	Opis
answers	KnowledgeBaseAnswer[]	Reprezentuje listę wyników odpowiedzi.

enable

Włączanie lub wyłączanie przewidywania answer span.

Nazwa	Typ	Opis
True	Boolean

Error

Obiekt error.

Nazwa	Typ	Opis
code	ErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	Error[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Czytelna dla człowieka reprezentacja błędu.
target	string	Element docelowy błędu.

ErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
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

Odpowiedź na błąd.

Nazwa	Typ	Opis
error	Error	Obiekt error.

InnerErrorCode

Kod błędu czytelny dla człowieka.

Nazwa	Typ	Opis
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Obiekt zawierający bardziej szczegółowe informacje o błędzie. Zgodnie z wytycznymi interfejsu MICROSOFT One API — https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nazwa	Typ	Opis
code	InnerErrorCode	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	object	Szczegóły błędu.
innererror	InnerErrorModel	Obiekt zawierający bardziej szczegółowe informacje niż bieżący obiekt o błędzie.
message	string	Komunikat o błędzie.
target	string	Błąd docelowy.

KnowledgeBaseAnswer

Reprezentuje odpowiedź baza wiedzy.

Nazwa	Typ	Opis
answer	string	Tekst odpowiedzi.
answerSpan	AnswerSpan	Odpowiedź obejmuje obiekt pytań i odpowiedzi w odniesieniu do pytania użytkownika.
confidenceScore	number	Odpowiedz na współczynnik ufności, zakresy wartości z zakresu od 0 do 1.
dialog	KnowledgeBaseAnswerDialog	Okno dialogowe skojarzone z odpowiedzią.
id	integer	Identyfikator wyniku pytań i pytań.
metadata	object	Metadane skojarzone z odpowiedzią, przydatne do kategoryzowania lub filtrowania odpowiedzi na pytania.
questions	string[]	Lista pytań skojarzonych z odpowiedzią.
source	string	Źródło wyniku pytań i pytań.

KnowledgeBaseAnswerContext

Obiekt kontekstu z informacjami z poprzednich pytań i pytań i pytań.

Nazwa	Typ	Opis
previousQnaId	integer	Poprzedni zwrot wyników odpowiedzi QnA ID.
previousUserQuery	string	Poprzednie zapytanie użytkownika.

KnowledgeBaseAnswerDialog

Okno dialogowe skojarzone z odpowiedzią.

Nazwa	Typ	Opis
isContextOnly	boolean	Aby zaznaczyć, czy monit ma zastosowanie tylko z poprzednim pytaniem, czy nie. Jeśli to prawda, nie dołączaj tej pytań i odpowiedzi jako wyników wyszukiwania dla zapytań bez kontekstu; w przeciwnym razie, jeśli wartość false, ignoruje kontekst i uwzględnia ten pytań i pytań w wynikach wyszukiwania.
prompts	KnowledgeBaseAnswerPrompt[]	Lista monitów skojarzonych z odpowiedzią.

KnowledgeBaseAnswerPrompt

Monituj o odpowiedź.

Nazwa	Typ	Opis
displayOrder	integer	Indeks monitu — używany w kolejności monitów.
displayText	string	Tekst wyświetlany do reprezentowania monitu o pytanie.
qnaId	integer	Identyfikator pytań i odpowiedzi odpowiadający monitowi.

LogicalOperationKind

Ustaw wartość "OR" lub "AND" na potrzeby używania odpowiedniej operacji logicznej.

Nazwa	Typ	Opis
AND	string
OR	string

MetadataFilter

Znajdź pytania i pytania, które są skojarzone z daną listą metadanych.

Nazwa	Typ	Wartość domyślna	Opis
logicalOperation	LogicalOperationKind	AND	Operacja używana do łączenia filtrów metadanych.
metadata	MetadataRecord[]		Obiekt zapewniający parę wartości klucza dla każdego metadanych.

MetadataRecord

Obiekt zapewniający parę wartości klucza dla każdego metadanych.

Nazwa	Typ	Opis
key	string	Klucz metadanych ze słownika metadanych używany w usłudze QnA.
value	string	Wartość metadanych ze słownika metadanych używanego w usłudze QnA.

QueryFilters

filtrów w baza wiedzy.

Nazwa	Typ	Wartość domyślna	Opis
logicalOperation	LogicalOperationKind	AND	Operacja logiczna używana do łączenia filtru metadanych z filtrem źródłowym.
metadataFilter	MetadataFilter		Znajdź pytania i pytania, które są skojarzone z daną listą metadanych.
sourceFilter	string[]		Znajdź pytania i pytania, które są skojarzone z dowolną z danej listy źródeł w baza wiedzy.

RankerKind

Typ klasyfikatora do użycia.

Nazwa	Typ	Opis
Default	string	Domyślny rangą.
QuestionOnly	string	Ranga tylko pytania.

ShortAnswerOptions

Aby skonfigurować funkcję przewidywania zakresu odpowiedzi.

Nazwa	Typ	Opis
confidenceScoreThreshold	number	Minimalny wynik progu wymagany do uwzględnienia zakresu odpowiedzi, zakresy wartości z zakresu od 0 do 1.
enable	enable	Włączanie lub wyłączanie przewidywania answer span.
topAnswersWithSpan	integer	Liczba najważniejszych odpowiedzi, które należy wziąć pod uwagę w przypadku przewidywania zakresu od 1 do 10.

Udostępnij za pośrednictwem