Question Answering Projects - Import
Importera projekttillgångar.
POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:import?api-version=2021-10-01
POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:import?api-version=2021-10-01&format={format}&assetKind={assetKind}
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com). |
project
|
path | True |
string |
Namnet på det projekt som ska användas. |
api-version
|
query | True |
string |
Klient-API-version. |
asset
|
query |
string |
Typ av projektets tillgång. |
|
format
|
query |
Import- eller exportformat för kunskapsbas. |
Begärandehuvud
Name | Obligatorisk | Typ | Description |
---|---|---|---|
Ocp-Apim-Subscription-Key | True |
string |
Begärandetext
Name | Typ | Description |
---|---|---|
assets |
Alla tillgångar för det här projektet. |
|
fileUri |
string |
Importera datafil-URI. |
metadata |
Parametrar som behövs för att skapa projektet. |
Svar
Name | Typ | Description |
---|---|---|
202 Accepted |
Ett lyckat anrop resulterar i ett Operation-Location-huvud som används för att kontrollera jobbets status. Headers Operation-Location: string |
|
Other Status Codes |
Felsvar. |
Säkerhet
Ocp-Apim-Subscription-Key
Type:
apiKey
In:
header
Exempel
Successful query
Sample Request
POST {Endpoint}/language/query-knowledgebases/projects/proj1/:import?api-version=2021-10-01
{
"assets": {
"synonyms": [
{
"alterations": [
"wa",
"washington",
"washington state"
]
},
{
"alterations": [
"U.S",
"usa",
"united states of america"
]
}
],
"qnas": [
{
"lastUpdatedDateTime": "2021-05-01T17:21:14Z",
"id": 1,
"answer": "ans1",
"source": "source1",
"questions": [
"question 1.1",
"question 1.2"
],
"metadata": {
"k1": "v1",
"k2": "v2"
},
"dialog": {
"isContextOnly": false,
"prompts": [
{
"displayOrder": 1,
"qnaId": 11,
"displayText": "prompt 1.1"
},
{
"displayOrder": 2,
"qnaId": 21,
"displayText": "prompt 1.2"
}
]
}
},
{
"lastUpdatedDateTime": "2021-05-01T17:21:14Z",
"id": 2,
"answer": "ans2",
"source": "source2",
"questions": [
"question 2.1",
"question 2.2"
]
}
]
}
}
Sample Response
Operation-Location: job1
Definitioner
Name | Description |
---|---|
Assets |
Alla tillgångar för det här projektet. |
Create |
Parametrar som behövs för att skapa projektet. |
Error |
Felobjektet. |
Error |
Felkod som kan läsas av människor. |
Error |
Felsvar. |
format |
Import- eller exportformat för kunskapsbas. |
Import |
Projekttillgångar som måste importeras. |
Import |
Importera QnA-post. |
Inner |
Felkod som kan läsas av människor. |
Inner |
Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
Konfigurerbara inställningar för projektet. |
Qna |
Dialogruta som är associerad med QnA-post. |
Qna |
Fråga efter ett svar. |
Qna |
QnA-post. |
Suggested |
Fråga som föreslås av funktionen Active Learning. |
Suggested |
Active Learning föreslog frågor om klusterinformation. |
Word |
Samling av ordvarieringar. |
Assets
Alla tillgångar för det här projektet.
Name | Typ | Description |
---|---|---|
qnas |
Lista över QnA-poster som ska importeras. |
|
synonyms |
Samling synonymer. |
CreateProjectOptions
Parametrar som behövs för att skapa projektet.
Name | Typ | Description |
---|---|---|
description |
string |
Beskrivning av projektet. |
language |
string |
Språk för textposterna. Detta är BCP-47-representation av ett språk. Använd till exempel "en" för engelska; "es" för spanska etc. Om det inte anges använder du "en" för engelska som standard. |
multilingualResource |
boolean |
Ställ in på true för att aktivera skapandet av kunskapsbaser på olika språk för samma resurs. |
settings |
Konfigurerbara inställningar för projektet. |
Error
Felobjektet.
Name | Typ | Description |
---|---|---|
code |
En av en serverdefinierad uppsättning felkoder. |
|
details |
Error[] |
En matris med information om specifika fel som ledde till det rapporterade felet. |
innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
message |
string |
En mänsklig läsbar representation av felet. |
target |
string |
Målet för felet. |
ErrorCode
Felkod som kan läsas av människor.
Name | Typ | 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
Felsvar.
Name | Typ | Description |
---|---|---|
error |
Felobjektet. |
format
Import- eller exportformat för kunskapsbas.
Name | Typ | Description |
---|---|---|
excel |
string |
Exportera eller importera kunskapsbas replik, inklusive alla tillgångar och metadata i Tsv-format. |
json |
string |
Exportera eller importera QnA-tillgångar i JSON-format. |
tsv |
string |
Exportera eller importera kunskapsbas replik, inklusive alla tillgångar och metadata i Excel-format. |
ImportJobOptions
Projekttillgångar som måste importeras.
Name | Typ | Description |
---|---|---|
assets |
Alla tillgångar för det här projektet. |
|
fileUri |
string |
Importera datafil-URI. |
metadata |
Parametrar som behövs för att skapa projektet. |
ImportQnaRecord
Importera QnA-post.
Name | Typ | Description |
---|---|---|
activeLearningSuggestions |
Lista över Active Learning-förslag för frågor och svar. |
|
answer |
string |
Svarstext. |
dialog |
Kontext för en QnA. |
|
id |
integer |
Unikt ID för QnA. |
lastUpdatedDateTime |
string |
Datum när QnA senast uppdaterades. |
metadata |
object |
Metadata som är associerade med svaret, användbara för att kategorisera eller filtrera frågesvar. |
questions |
string[] |
Lista över frågor som är associerade med svaret. |
source |
string |
Källa från vilken QnA indexerades, t.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . |
sourceDisplayName |
string |
Eget namn på källan. |
InnerErrorCode
Felkod som kan läsas av människor.
Name | Typ | Description |
---|---|---|
AzureCognitiveSearchNotFound |
string |
|
AzureCognitiveSearchThrottling |
string |
|
ExtractionFailure |
string |
|
InvalidParameterValue |
string |
|
InvalidRequest |
string |
|
KnowledgeBaseNotFound |
string |
InnerErrorModel
Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
Name | Typ | Description |
---|---|---|
code |
En av en serverdefinierad uppsättning felkoder. |
|
details |
object |
Felinformation. |
innererror |
Ett objekt som innehåller mer specifik information än det aktuella objektet om felet. |
|
message |
string |
Felmeddelande. |
target |
string |
Felmål. |
ProjectSettings
Konfigurerbara inställningar för projektet.
Name | Typ | Description |
---|---|---|
defaultAnswer |
string |
Standardsvar när ingen bra matchning hittas i kunskapsbas. |
QnaDialog
Dialogruta som är associerad med QnA-post.
Name | Typ | Description |
---|---|---|
isContextOnly |
boolean |
Markera om en fråga endast är relevant med en tidigare fråga eller inte. Om det är sant ska du inte ta med denna QnA som svar för frågor utan kontext. annars ignoreras kontexten och den här QnA:en inkluderas i svar. |
prompts |
Lista över frågor som är associerade med svaret. |
QnaPrompt
Fråga efter ett svar.
Name | Typ | Description |
---|---|---|
displayOrder |
integer |
Index för prompten. Den används för att ordna prompterna. |
displayText |
string |
Text som visas för att representera en fråga om uppföljningsfråga. |
qna |
QnA-post. Antingen måste QnAId- eller QnA-posten finnas i en prompt. |
|
qnaId |
integer |
ID för den QnA som motsvarar prompten. |
QnaRecord
QnA-post.
Name | Typ | Description |
---|---|---|
activeLearningSuggestions |
Lista över Active Learning-förslag för frågor och svar. |
|
answer |
string |
Svarstext. |
dialog |
Kontext för en QnA. |
|
id |
integer |
Unikt ID för QnA. |
metadata |
object |
Metadata som är associerade med svaret, användbara för att kategorisera eller filtrera frågesvar. |
questions |
string[] |
Lista över frågor som är associerade med svaret. |
source |
string |
Källa från vilken QnA indexerades, t.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs . |
SuggestedQuestion
Fråga som föreslås av funktionen Active Learning.
Name | Typ | Description |
---|---|---|
autoSuggestedCount |
integer |
Antalet gånger som frågan föreslogs automatiskt av Active Learning-algoritmen. |
question |
string |
Fråga som föreslås av funktionen Active Learning. |
userSuggestedCount |
integer |
Antalet gånger som frågan uttryckligen föreslogs av användaren. |
SuggestedQuestionsCluster
Active Learning föreslog frågor om klusterinformation.
Name | Typ | Description |
---|---|---|
clusterHead |
string |
Fråga som valts som chef för det föreslagna frågeklustret av algoritmen för Active Learning-klustring. |
suggestedQuestions |
Lista över alla föreslagna frågor för frågor och svar. |
WordAlterations
Samling av ordvarieringar.
Name | Typ | Description |
---|---|---|
alterations |
string[] |
Samling av ordvarieringar. |