Question Answering - Get Answers
Odpowiada na określone pytanie przy użyciu baza wiedzy.
POST {Endpoint}/language/:query-knowledgebases?projectName={projectName}&deploymentName={deploymentName}&api-version=2023-04-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. |
deployment
|
query | True |
string |
Nazwa konkretnego wdrożenia projektu do użycia. |
project
|
query | True |
string |
Nazwa projektu do użycia. |
Treść żądania
Nazwa | Typ | Opis |
---|---|---|
answerSpanRequest |
Aby skonfigurować funkcję przewidywania zakresu odpowiedzi. |
|
confidenceScoreThreshold |
number |
Minimalny wynik progu dla odpowiedzi, zakresy wartości z zakresu od 0 do 1. |
context |
Obiekt kontekstu z informacjami z poprzednich pytań i pytań i pytań. |
|
filters |
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 |
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 |
Pomyślna odpowiedź na uzyskanie odpowiedzi z baza wiedzy. |
|
Other Status Codes |
Odpowiedź na błąd. |
Zabezpieczenia
AADToken
Są to przepływy OAuth2 usługi Azure Active Directory . Po połączeniu z kontrolą dostępu opartą na rolach platformy Azure może służyć do kontrolowania dostępu do interfejsów API REST Azure Maps. Mechanizmy kontroli dostępu opartej na rolach platformy Azure służą do wyznaczania dostępu do co najmniej jednego Azure Maps konta zasobu lub zasobów podrzędnych. Każdy użytkownik, grupa lub jednostka usługi może mieć dostęp za pośrednictwem wbudowanej roli lub roli niestandardowej składającej się z co najmniej jednego uprawnienia do Azure Maps interfejsów API REST.
Aby zaimplementować scenariusze, zalecamy wyświetlenie pojęć związanych z uwierzytelnianiem. Podsumowując, ta definicja zabezpieczeń stanowi rozwiązanie do modelowania aplikacji za pośrednictwem obiektów, które mogą kontrolować dostęp do określonych interfejsów API i zakresów.
Uwagi
- Ta definicja zabezpieczeń wymaga użycia nagłówka
x-ms-client-id
w celu wskazania, do którego zasobu Azure Maps aplikacja żąda dostępu. Można to uzyskać z poziomu interfejsu API zarządzania usługami Maps.
Element Authorization URL
jest specyficzny dla wystąpienia chmury publicznej platformy Azure. Suwerenne chmury mają unikatowe adresy URL autoryzacji i konfiguracje usługi Azure Active Directory.
* Kontrola dostępu oparta na rolach platformy Azure jest konfigurowana z poziomu płaszczyzny zarządzania platformy Azure za pośrednictwem Azure Portal, programu PowerShell, interfejsu wiersza polecenia, zestawów AZURE SDK lub interfejsów API REST.
* Użycie zestawu AZURE MAPS Web SDK umożliwia skonfigurowanie aplikacji na podstawie konfiguracji dla wielu przypadków użycia.
- Obecnie usługa Azure Active Directory w wersji 1.0 lub 2.0 obsługuje konta służbowe, szkolne i gości, ale nie obsługują kont osobistych.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Klucz subskrypcji zasobu usługi językowej.
Type:
apiKey
In:
header
Przykłady
Successful query
Sample Request
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
{
"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 |
---|---|
Answers |
Parametry do wykonywania zapytania o baza wiedzy. |
Answer |
Odpowiedź obejmuje obiekt pytań i odpowiedzi. |
Answers |
Reprezentuje listę odpowiedzi na pytania. |
enable |
Włączanie lub wyłączanie przewidywania answer span. |
Error |
Obiekt error. |
Error |
Kod błędu czytelny dla człowieka. |
Error |
Odpowiedź na błąd. |
Inner |
Kod błędu czytelny dla człowieka. |
Inner |
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. |
Knowledge |
Reprezentuje odpowiedź baza wiedzy. |
Knowledge |
Obiekt kontekstu z informacjami z poprzednich pytań i pytań i pytań. |
Knowledge |
Okno dialogowe skojarzone z odpowiedzią. |
Knowledge |
Monituj o odpowiedź. |
Logical |
Ustaw wartość "OR" lub "AND" na potrzeby używania odpowiedniej operacji logicznej. |
Metadata |
Znajdź pytania i pytania, które są skojarzone z daną listą metadanych. |
Metadata |
Obiekt zapewniający parę wartości klucza dla każdego metadanych. |
Query |
filtrów w baza wiedzy. |
Ranker |
Typ klasyfikatora do użycia. |
Short |
Aby skonfigurować funkcję przewidywania zakresu odpowiedzi. |
AnswersOptions
Parametry do wykonywania zapytania o baza wiedzy.
Nazwa | Typ | Opis |
---|---|---|
answerSpanRequest |
Aby skonfigurować funkcję przewidywania zakresu odpowiedzi. |
|
confidenceScoreThreshold |
number |
Minimalny wynik progu dla odpowiedzi, zakresy wartości z zakresu od 0 do 1. |
context |
Obiekt kontekstu z informacjami z poprzednich pytań i pytań i pytań. |
|
filters |
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 |
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 |
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 |
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 |
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 |
|
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
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error |
Obiekt error. |
InnerErrorCode
Kod błędu czytelny dla człowieka.
Nazwa | Typ | Opis |
---|---|---|
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
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 |
Jeden z zdefiniowanych przez serwer zestaw kodów błędów. |
|
details |
object |
Szczegóły błędu. |
innererror |
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 |
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 |
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 |
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 | AND |
Operacja używana do łączenia filtrów metadanych. |
|
metadata |
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 | AND |
Operacja logiczna używana do łączenia filtru metadanych z filtrem źródłowym. |
|
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 |
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. |