Dela via

Question Answering Projects - Import

  • Referens
Tjänst:
Azure AI Services
API-version:
2021-10-01

Importera projekttillgångar.

POST {Endpoint}/language/query-knowledgebases/projects/{projectName}/:import?api-version=2021-10-01
Med valfria parametrar: 
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).
projectName
 path True

string

maxLength: 100

Namnet på projektet som ska användas.
api-version
 query True

string

Klient-API-version.
assetKind
 query

string

Typ av projektets tillgång.
format
 query

format

Format för import eller export av kunskapsbas.

Begärandehuvud

Name Obligatorisk Typ Description
Ocp-Apim-Subscription-Key True

string

Begärandetext

Name Typ Description
assets

Assets

Alla tillgångar för det här projektet.
fileUri

string

Importera datafil-URI.
metadata

CreateProjectOptions

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.

Sidhuvuden

Operation-Location: string
Other Status Codes

ErrorResponse

Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

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

Exempelsvar

Statuskod:
202 
Operation-Location: job1

Definitioner

Name Description
Assets

Alla tillgångar för det här projektet.
CreateProjectOptions

Parametrar som behövs för att skapa projektet.
Error

Felobjektet.
ErrorCode

Felkod som kan läsas av människor.
ErrorResponse

Felsvar.
format

Format för import eller export av kunskapsbas.
ImportJobOptions

Projekttillgångar som måste importeras.
ImportQnaRecord

Importera QnA-post.
InnerErrorCode

Felkod som kan läsas av människor.
InnerErrorModel

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectSettings

Konfigurerbara inställningar för projektet.
QnaDialog

Dialogruta som är associerad med QnA-post.
QnaPrompt

Fråga efter ett svar.
QnaRecord

QnA-post.
SuggestedQuestion

Fråga som föreslås av funktionen Active Learning.
SuggestedQuestionsCluster

Active Learning föreslog frågor om klusterinformation.
WordAlterations

Samling ordändringar.

Assets

Objekt

Alla tillgångar för det här projektet.

Name Typ Description
qnas

ImportQnaRecord[]

Lista över QnA-poster som ska importeras.
synonyms

WordAlterations[]

Samling synonymer.

CreateProjectOptions

Objekt

Parametrar som behövs för att skapa projektet.

Name Typ Description
description

string

Beskrivning av projektet.
language

string

Språk för textposterna. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska; "es" för spanska etc. Om du inte anger använder du "en" för engelska som standard.
multilingualResource

boolean

Ställ in på true för att skapa kunskapsbaser på olika språk för samma resurs.
settings

ProjectSettings

Konfigurerbara inställningar för projektet.

Error

Objekt

Felobjektet.

Name Typ Description
code

ErrorCode

En av en serverdefinierad uppsättning felkoder.
details

Error[]

En matris med information om specifika fel som ledde till det rapporterade felet.
innererror

InnerErrorModel

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

Uppräkning

Felkod som kan läsas av människor.

Värde Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Objekt

Felsvar.

Name Typ Description
error

Error

Felobjektet.

format

Uppräkning

Format för import eller export av kunskapsbas.

Värde Description
excel

Exportera eller importera kunskapsbasreplik, inklusive alla tillgångar och metadata i Tsv-format.
json

Exportera eller importera QnA-tillgångar i JSON-format.
tsv

Exportera eller importera kunskapsbasreplik, inklusive alla tillgångar och metadata i Excel-format.

ImportJobOptions

Objekt

Projekttillgångar som måste importeras.

Name Typ Description
assets

Assets

Alla tillgångar för det här projektet.
fileUri

string

Importera datafil-URI.
metadata

CreateProjectOptions

Parametrar som behövs för att skapa projektet.

ImportQnaRecord

Objekt

Importera QnA-post.

Name Typ Description
activeLearningSuggestions

SuggestedQuestionsCluster[]

Lista över Active Learning-förslag för QnA.
answer

string

minLength: 1
maxLength: 25000

Besvara text.
dialog

QnaDialog

Kontext för en QnA.
id

integer (int32)

Unikt ID för QnA.
lastUpdatedDateTime

string (date-time)

Datum då 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

maxLength: 300

Källa från vilken QnA indexerades, t.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .
sourceDisplayName

string

minLength: 1
maxLength: 200

Eget namn på källan.

InnerErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Typ Description
code

InnerErrorCode

En av en serverdefinierad uppsättning felkoder.
details

object

Felinformation.
innererror

InnerErrorModel

Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message

string

Felmeddelande.
target

string

Felmål.

ProjectSettings

Objekt

Konfigurerbara inställningar för projektet.

Name Typ Description
defaultAnswer

string

Svarssvar som standard när ingen bra matchning hittas i kunskapsbasen.

QnaDialog

Objekt

Dialogruta som är associerad med QnA-post.

Name Typ Description
isContextOnly

boolean

Att 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 ignorerar kontexten och inkluderar denna QnA i svar.
prompts

QnaPrompt[]

Lista över frågor som är associerade med svaret.

QnaPrompt

Objekt

Fråga efter ett svar.

Name Typ Description
displayOrder

integer (int32)

Index för prompten. Den används för att beställa prompterna.
displayText

string

maxLength: 200

Text som visas för att representera en fråga om uppföljning.
qna

QnaRecord

QnA-post. Antingen QnAId- eller QnA-post måste finnas i en prompt.
qnaId

integer (int32)

ID för QnA som motsvarar prompten.

QnaRecord

Objekt

QnA-post.

Name Typ Description
activeLearningSuggestions

SuggestedQuestionsCluster[]

Lista över Active Learning-förslag för QnA.
answer

string

minLength: 1
maxLength: 25000

Besvara text.
dialog

QnaDialog

Kontext för en QnA.
id

integer (int32)

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

maxLength: 300

Källa från vilken QnA indexerades, t.ex. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .

SuggestedQuestion

Objekt

Fråga som föreslås av funktionen Active Learning.

Name Typ Description
autoSuggestedCount

integer (int32)

Antalet gånger frågan föreslogs automatiskt av Active Learning-algoritmen.
question

string

Fråga som föreslås av funktionen Active Learning.
userSuggestedCount

integer (int32)

Antalet gånger som frågan föreslogs uttryckligen av användaren.

SuggestedQuestionsCluster

Objekt

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 Active Learning-klustringsalgoritmen.
suggestedQuestions

SuggestedQuestion[]

Lista över alla föreslagna frågor för QnA.

WordAlterations

Objekt

Samling ordändringar.

Name Typ Description
alterations

string[]

Samling ordändringar.