Question Answering - Get Answers
Odpoví na zadanou otázku pomocí znalostní báze.
POST {Endpoint}/language/:query-knowledgebases?projectName={projectName}&deploymentName={deploymentName}&api-version=2023-04-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
Verze rozhraní API klienta. |
deployment
|
query | True |
string |
Název konkrétního nasazení projektu, který se má použít. |
project
|
query | True |
string |
Název projektu, který se má použít. |
Text požadavku
Name | Typ | Description |
---|---|---|
answerSpanRequest |
Konfigurace funkce predikce rozsahu odpovědí |
|
confidenceScoreThreshold |
number |
Minimální prahové skóre pro odpovědi, hodnota se pohybuje od 0 do 1. |
context |
Kontextový objekt s předchozími informacemi QnA |
|
filters |
Filtrovat QnAs na základě daného seznamu metadat a znalostní báze zdrojů. |
|
includeUnstructuredSources |
boolean |
(Volitelné) Příznak pro povolení dotazu na nestrukturované zdroje |
qnaId |
integer |
Přesné ID QnA, které se má načíst z znalostní báze, toto pole má přednost před otázkou. |
question |
string |
Dotaz uživatele na znalostní báze |
rankerType |
Typ rankeru, který se má použít. |
|
top |
integer |
Maximální počet odpovědí, které se mají na otázku vrátit. |
userId |
string |
Jedinečný identifikátor uživatele. |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Úspěšná odpověď pro získání odpovědí od znalostní báze. |
|
Other Status Codes |
Chybová odpověď. |
Zabezpečení
AADToken
Toto jsou toky Azure Active Directory OAuth2 . Při spárování s řízením přístupu na základě role v Azure se dá použít k řízení přístupu k Azure Maps rozhraní REST API. Řízení přístupu na základě role v Azure slouží k určení přístupu k jednomu nebo několika Azure Maps účtu prostředku nebo dílčím prostředkům. Každému uživateli, skupině nebo instančnímu objektu je možné udělit přístup prostřednictvím předdefinované role nebo vlastní role složené z jednoho nebo více oprávnění k Azure Maps rozhraní REST API.
Pokud chcete implementovat scénáře, doporučujeme zobrazit si koncepty ověřování. Souhrnně řečeno, tato definice zabezpečení poskytuje řešení pro modelování aplikací prostřednictvím objektů schopných řízení přístupu pro konkrétní rozhraní API a obory.
Poznámky
- Tato definice zabezpečení vyžaduje použití hlavičky
x-ms-client-id
k označení Azure Maps prostředku, ke kterému aplikace žádá o přístup. Můžete ho získat z rozhraní MAPS MANAGEMENT API.
Je Authorization URL
specifický pro instanci veřejného cloudu Azure. Suverénní cloudy mají jedinečné autorizační adresy URL a konfigurace Azure Active Directory.
* Řízení přístupu na základě role v Azure se konfiguruje z roviny správy Azure prostřednictvím Azure Portal, PowerShellu, rozhraní příkazového řádku, sad Azure SDK nebo rozhraní REST API.
* Použití sady AZURE MAPS Web SDK umožňuje nastavení aplikace na základě konfigurace pro více případů použití.
- Azure Active Directory verze 1.0 nebo 2.0 v současné době podporuje pracovní, školní a hosta, ale nepodporuje osobní účty.
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
Klíč předplatného pro prostředek služby jazyka.
Typ:
apiKey
V:
header
Příklady
Successful query
Ukázkový požadavek
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
}
Ukázková odpověď
{
"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"
}
]
}
Definice
Name | Description |
---|---|
Answers |
Parametry pro dotazování znalostní báze |
Answer |
Answer span object of QnA. |
Answers |
Představuje seznam odpovědí na otázky. |
enable |
Povolte nebo zakažte predikci Answer Span. |
Error |
Objekt chyby. |
Error |
Kód chyby čitelný pro člověka. |
Error |
Chybová odpověď. |
Inner |
Kód chyby čitelný pro člověka. |
Inner |
Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Knowledge |
Představuje znalostní báze odpověď. |
Knowledge |
Kontextový objekt s předchozími informacemi QnA |
Knowledge |
Dialogové okno přidružené k odpovědi |
Knowledge |
Výzva k zadání odpovědi |
Logical |
Pokud chcete použít odpovídající logickou operaci, nastavte hodnotu OR nebo AND. |
Metadata |
Vyhledejte otázky, které jsou přidružené k danému seznamu metadat. |
Metadata |
Objekt poskytující dvojici hodnot klíčů pro jednotlivá metadata. |
Query |
filtruje znalostní báze. |
Ranker |
Typ rankeru, který se má použít. |
Short |
Konfigurace funkce predikce rozsahu odpovědí |
AnswersOptions
Parametry pro dotazování znalostní báze
Name | Typ | Description |
---|---|---|
answerSpanRequest |
Konfigurace funkce predikce rozsahu odpovědí |
|
confidenceScoreThreshold |
number |
Minimální prahové skóre pro odpovědi, hodnota se pohybuje od 0 do 1. |
context |
Kontextový objekt s předchozími informacemi QnA |
|
filters |
Filtrovat QnAs na základě daného seznamu metadat a znalostní báze zdrojů. |
|
includeUnstructuredSources |
boolean |
(Volitelné) Příznak pro povolení dotazu na nestrukturované zdroje |
qnaId |
integer |
Přesné ID QnA, které se má načíst z znalostní báze, toto pole má přednost před otázkou. |
question |
string |
Dotaz uživatele na znalostní báze |
rankerType |
Typ rankeru, který se má použít. |
|
top |
integer |
Maximální počet odpovědí, které se mají na otázku vrátit. |
userId |
string |
Jedinečný identifikátor uživatele. |
AnswerSpan
Answer span object of QnA.
Name | Typ | Description |
---|---|---|
confidenceScore |
number |
Predikované skóre rozsahu odpovědí, rozsahy hodnot od 0 do 1. |
length |
integer |
Délka rozsahu odpovědí. |
offset |
integer |
Rozsah odpovědi se posune od začátku odpovědi. |
text |
string |
Predikovaný text rozsahu odpovědí |
AnswersResult
Představuje seznam odpovědí na otázky.
Name | Typ | Description |
---|---|---|
answers |
Představuje seznam Výsledků odpovědi. |
enable
Povolte nebo zakažte predikci Answer Span.
Name | Typ | Description |
---|---|---|
True |
Boolean |
Error
Objekt chyby.
Name | Typ | Description |
---|---|---|
code |
Jeden ze serverem definovaných chybových kódů. |
|
details |
Error[] |
Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě. |
innererror |
Objekt obsahující konkrétnější informace o chybě než aktuální objekt. |
|
message |
string |
Lidsky čitelná reprezentace chyby. |
target |
string |
Cíl chyby. |
ErrorCode
Kód chyby čitelný pro člověka.
Name | Typ | 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
Chybová odpověď.
Name | Typ | Description |
---|---|---|
error |
Objekt chyby. |
InnerErrorCode
Kód chyby čitelný pro člověka.
Name | Typ | 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
Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní MICROSOFT One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Description |
---|---|---|
code |
Jeden ze serverem definovaných chybových kódů. |
|
details |
object |
Podrobnosti o chybě. |
innererror |
Objekt obsahující konkrétnější informace o chybě než aktuální objekt. |
|
message |
string |
Chybová zpráva. |
target |
string |
Cíl chyby. |
KnowledgeBaseAnswer
Představuje znalostní báze odpověď.
Name | Typ | Description |
---|---|---|
answer |
string |
Text odpovědi. |
answerSpan |
Answer span object of QnA s ohledem na otázku uživatele. |
|
confidenceScore |
number |
Skóre spolehlivosti odpovědi, hodnoty se pohybují od 0 do 1. |
dialog |
Dialogové okno přidružené k odpovědi |
|
id |
integer |
ID výsledku QnA |
metadata |
object |
Metadata přidružená k odpovědi, která jsou užitečná pro kategorizaci nebo filtrování odpovědí na otázky. |
questions |
string[] |
Seznam otázek souvisejících s odpovědí |
source |
string |
Zdroj výsledku QnA |
KnowledgeBaseAnswerContext
Kontextový objekt s předchozími informacemi QnA
Name | Typ | Description |
---|---|---|
previousQnaId |
integer |
Předchozí turn top answer result QnA ID. |
previousUserQuery |
string |
Předchozí uživatelský dotaz. |
KnowledgeBaseAnswerDialog
Dialogové okno přidružené k odpovědi
Name | Typ | Description |
---|---|---|
isContextOnly |
boolean |
Pokud chcete označit, jestli je výzva relevantní jenom u předchozí otázky, nebo ne. Pokud je true, nezahrnujte tuto QnA jako výsledek hledání pro dotazy bez kontextu; v opačném případě ignoruje kontext a zahrne tuto funkci QnA do výsledku hledání. |
prompts |
Seznam výzev přidružených k odpovědi |
KnowledgeBaseAnswerPrompt
Výzva k zadání odpovědi
Name | Typ | Description |
---|---|---|
displayOrder |
integer |
Index výzvy – používá se v pořadí výzev. |
displayText |
string |
Zobrazený text představující výzvu k následné otázce |
qnaId |
integer |
ID QnA odpovídající výzvě. |
LogicalOperationKind
Pokud chcete použít odpovídající logickou operaci, nastavte hodnotu OR nebo AND.
Name | Typ | Description |
---|---|---|
AND |
string |
|
OR |
string |
MetadataFilter
Vyhledejte otázky, které jsou přidružené k danému seznamu metadat.
Name | Typ | Default value | Description |
---|---|---|---|
logicalOperation | AND |
Operace použitá ke spojení filtrů metadat. |
|
metadata |
Objekt poskytující dvojici hodnot klíčů pro jednotlivá metadata. |
MetadataRecord
Objekt poskytující dvojici hodnot klíčů pro jednotlivá metadata.
Name | Typ | Description |
---|---|---|
key |
string |
Klíč metadat ze slovníku metadat, který se používá ve službě QnA. |
value |
string |
Hodnota metadat ze slovníku metadat, který se používá ve službě QnA. |
QueryFilters
filtruje znalostní báze.
Name | Typ | Default value | Description |
---|---|---|---|
logicalOperation | AND |
Logická operace používaná ke spojení filtru metadat se zdrojovým filtrem. |
|
metadataFilter |
Vyhledejte otázky, které jsou přidružené k danému seznamu metadat. |
||
sourceFilter |
string[] |
Vyhledejte otázky, které jsou přidružené k libovolnému seznamu zdrojů v znalostní báze. |
RankerKind
Typ rankeru, který se má použít.
Name | Typ | Description |
---|---|---|
Default |
string |
Výchozí ranker. |
QuestionOnly |
string |
Jen otázka ranker. |
ShortAnswerOptions
Konfigurace funkce predikce rozsahu odpovědí
Name | Typ | Description |
---|---|---|
confidenceScoreThreshold |
number |
Skóre minimální prahové hodnoty potřebné k zahrnutí rozsahu odpovědí a rozsahu hodnot od 0 do 1. |
enable |
Povolte nebo zakažte predikci Answer Span. |
|
topAnswersWithSpan |
integer |
Počet nejčastějších odpovědí, které je potřeba vzít v úvahu pro předpověď rozsahu od 1 do 10 |