Question Answering - Get Answers
Beantwoord de opgegeven vraag met behulp van uw Knowledge Base.
POST {Endpoint}/language/:query-knowledgebases?projectName={projectName}&deploymentName={deploymentName}&api-version=2021-10-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
Client-API-versie. |
deployment
|
query | True |
string |
De naam van de specifieke implementatie van het project dat moet worden gebruikt. |
project
|
query | True |
string |
De naam van het project dat moet worden gebruikt. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Aanvraagbody
Name | Type | Description |
---|---|---|
answerSpanRequest |
De voorspellingsfunctie Antwoordbereik configureren. |
|
confidenceScoreThreshold |
number |
Minimumdrempelscore voor antwoorden, waarde varieert van 0 tot 1. |
context |
Contextobject met eerdere QnA-gegevens. |
|
filters |
Filter QnA's op basis van de opgegeven metagegevenslijst en Knowledge Base bronnen. |
|
includeUnstructuredSources |
boolean |
(Optioneel) Vlag om query's op ongestructureerde bronnen in te schakelen. |
qnaId |
integer |
Exacte QnA-id die moet worden opgehaald uit de Knowledge Base. Dit veld heeft prioriteit boven vraag. |
question |
string |
Vraag van de gebruiker om een query uit te voeren op de Knowledge Base. |
rankerType |
Het type ranker dat moet worden gebruikt. |
|
top |
integer |
Maximum aantal antwoorden dat moet worden geretourneerd voor de vraag. |
userId |
string |
Unieke id voor de gebruiker. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK |
Een geslaagd antwoord om antwoorden te krijgen van Knowledge Base. |
|
Other Status Codes |
Foutreactie. |
Beveiliging
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Voorbeelden
Successful query
Sample Request
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
{
"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"
}
]
}
Definities
Name | Description |
---|---|
Answers |
Parameters om een query uit te voeren op een Knowledge Base. |
Answer |
Answer Span-object van QnA. |
Answers |
Vertegenwoordigt een lijst met antwoorden op vragen. |
enable |
Voorspelling van antwoordbereik in- of uitschakelen. |
Error |
Het foutobject. |
Error |
Door mensen leesbare foutcode. |
Error |
Foutreactie. |
Inner |
Door mensen leesbare foutcode. |
Inner |
Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Knowledge |
Vertegenwoordigt Knowledge Base antwoord. |
Knowledge |
Contextobject met eerdere QnA-gegevens. |
Knowledge |
Dialoogvenster dat is gekoppeld aan Answer. |
Knowledge |
Vragen om een antwoord. |
Logical |
Stel in op 'OR' of 'AND' voor het gebruik van de bijbehorende logische bewerking. |
Metadata |
Zoek QnA's die zijn gekoppeld aan de opgegeven lijst met metagegevens. |
Metadata |
Object om het sleutelwaardepaar voor elke metagegevens op te geven. |
Query |
filtert op Knowledge Base. |
Ranker |
Het type ranker dat moet worden gebruikt. |
Short |
De voorspellingsfunctie Antwoordbereik configureren. |
AnswersOptions
Parameters om een query uit te voeren op een Knowledge Base.
Name | Type | Description |
---|---|---|
answerSpanRequest |
De voorspellingsfunctie Antwoordbereik configureren. |
|
confidenceScoreThreshold |
number |
Minimumdrempelscore voor antwoorden, waarde varieert van 0 tot 1. |
context |
Contextobject met eerdere QnA-gegevens. |
|
filters |
Filter QnA's op basis van de opgegeven metagegevenslijst en Knowledge Base bronnen. |
|
includeUnstructuredSources |
boolean |
(Optioneel) Vlag om query's op ongestructureerde bronnen in te schakelen. |
qnaId |
integer |
Exacte QnA-id die moet worden opgehaald uit de Knowledge Base. Dit veld heeft prioriteit boven vraag. |
question |
string |
Vraag van de gebruiker om een query uit te voeren op de Knowledge Base. |
rankerType |
Het type ranker dat moet worden gebruikt. |
|
top |
integer |
Maximum aantal antwoorden dat moet worden geretourneerd voor de vraag. |
userId |
string |
Unieke id voor de gebruiker. |
AnswerSpan
Answer Span-object van QnA.
Name | Type | Description |
---|---|---|
confidenceScore |
number |
Voorspelde score van antwoordbereik, waarde varieert van 0 tot 1. |
length |
integer |
De lengte van het antwoordbereik. |
offset |
integer |
De verschuiving van de antwoordbereik vanaf het begin van het antwoord. |
text |
string |
Voorspelde tekst van antwoordbereik. |
AnswersResult
Vertegenwoordigt een lijst met antwoorden op vragen.
Name | Type | Description |
---|---|---|
answers |
Vertegenwoordigt de lijst met antwoordresultaten. |
enable
Voorspelling van antwoordbereik in- of uitschakelen.
Name | Type | Description |
---|---|---|
True |
Boolean |
Error
Het foutobject.
Name | Type | Description |
---|---|---|
code |
Een van een door de server gedefinieerde set foutcodes. |
|
details |
Error[] |
Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid. |
innererror |
Een object met specifiekere informatie dan het huidige object over de fout. |
|
message |
string |
Een door mensen leesbare weergave van de fout. |
target |
string |
Het doel van de fout. |
ErrorCode
Door mensen leesbare foutcode.
Name | Type | 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
Foutreactie.
Name | Type | Description |
---|---|---|
error |
Het foutobject. |
InnerErrorCode
Door mensen leesbare foutcode.
Name | Type | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
ExtractionFailure |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
KnowledgeBaseNotFound |
string |
InnerErrorModel
Een object met specifiekere informatie over de fout. Volgens de richtlijnen voor Microsoft One API: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Type | Description |
---|---|---|
code |
Een van een door de server gedefinieerde set foutcodes. |
|
details |
object |
Foutdetails. |
innererror |
Een object met specifiekere informatie dan het huidige object over de fout. |
|
message |
string |
Foutbericht. |
target |
string |
Foutdoel. |
KnowledgeBaseAnswer
Vertegenwoordigt Knowledge Base antwoord.
Name | Type | Description |
---|---|---|
answer |
string |
Antwoordtekst. |
answerSpan |
Beantwoord het span-object van QnA met betrekking tot de vraag van de gebruiker. |
|
confidenceScore |
number |
Betrouwbaarheidsscore beantwoorden, waarde varieert van 0 tot 1. |
dialog |
Dialoogvenster dat is gekoppeld aan Answer. |
|
id |
integer |
Id van het QnA-resultaat. |
metadata |
object |
Metagegevens die aan het antwoord zijn gekoppeld, zijn handig om vragen te categoriseren of te filteren. |
questions |
string[] |
Lijst met vragen die zijn gekoppeld aan het antwoord. |
source |
string |
Bron van QnA-resultaat. |
KnowledgeBaseAnswerContext
Contextobject met eerdere QnA-gegevens.
Name | Type | Description |
---|---|---|
previousQnaId |
integer |
Vorige beurt antwoord resultaat QnA-id. |
previousUserQuery |
string |
Vorige gebruikersquery. |
KnowledgeBaseAnswerDialog
Dialoogvenster dat is gekoppeld aan Answer.
Name | Type | Description |
---|---|---|
isContextOnly |
boolean |
Markeren of een prompt alleen relevant is voor een eerdere vraag of niet. Als dit waar is, moet u deze QnA niet opnemen als zoekresultaat voor query's zonder context; anders, indien onwaar, negeert context en neemt deze QnA op in het zoekresultaat. |
prompts |
Lijst met prompts die zijn gekoppeld aan het antwoord. |
KnowledgeBaseAnswerPrompt
Vragen om een antwoord.
Name | Type | Description |
---|---|---|
displayOrder |
integer |
Index van de prompt - gebruikt bij het ordenen van de prompts. |
displayText |
string |
Tekst die wordt weergegeven om een vervolgvraagprompt weer te geven. |
qnaId |
integer |
QnA-id die overeenkomt met de prompt. |
LogicalOperationKind
Stel in op 'OR' of 'AND' voor het gebruik van de bijbehorende logische bewerking.
Name | Type | Description |
---|---|---|
AND |
string |
|
OR |
string |
MetadataFilter
Zoek QnA's die zijn gekoppeld aan de opgegeven lijst met metagegevens.
Name | Type | Standaardwaarde | Description |
---|---|---|---|
logicalOperation | AND |
Bewerking die wordt gebruikt om metagegevensfilters samen te voegen. |
|
metadata |
Object om het sleutelwaardepaar voor elke metagegevens op te geven. |
MetadataRecord
Object om het sleutelwaardepaar voor elke metagegevens op te geven.
Name | Type | Description |
---|---|---|
key |
string |
Metagegevenssleutel uit metagegevenswoordenlijst die wordt gebruikt in de QnA. |
value |
string |
Metagegevenswaarde uit de metagegevenswoordenlijst die wordt gebruikt in de QnA. |
QueryFilters
filtert op Knowledge Base.
Name | Type | Standaardwaarde | Description |
---|---|---|---|
logicalOperation | AND |
Logische bewerking die wordt gebruikt om het metagegevensfilter samen te voegen met het bronfilter. |
|
metadataFilter |
Zoek QnA's die zijn gekoppeld aan de opgegeven lijst met metagegevens. |
||
sourceFilter |
string[] |
Zoek QnA's die zijn gekoppeld aan een van de opgegeven bronnen in Knowledge Base. |
RankerKind
Het type ranker dat moet worden gebruikt.
Name | Type | Description |
---|---|---|
Default |
string |
Standaardrangschikking. |
QuestionOnly |
string |
Vraag alleen ranker. |
ShortAnswerOptions
De voorspellingsfunctie Antwoordbereik configureren.
Name | Type | Description |
---|---|---|
confidenceScoreThreshold |
number |
Minimumdrempelscore die is vereist voor het opnemen van een antwoordbereik, waarde varieert van 0 tot 1. |
enable |
Voorspelling van antwoordbereik in- of uitschakelen. |
|
topAnswersWithSpan |
integer |
Het aantal belangrijkste antwoorden dat in aanmerking moet worden genomen voor de bereikvoorspelling van 1 tot 10. |