Question Answering Projects - Export

Tjänst:

Azure AI Services

API-version:

2023-04-15-preview

Exportera projektmetadata och tillgångar.

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?api-version=2023-04-15-preview

Med valfria parametrar:

POST {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/:export?api-version=2023-04-15-preview&format={format}&assetKind={assetKind}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
projectName	path	True	string	Namnet på projektet som ska användas.
api-version	query	True	string	Klient-API-version.
assetKind	query		assetKind	Typ av projektets tillgång.
format	query		format	Format för import eller export av kunskapsbas.

Svar

Name	Typ	Description
200 OK	ExportJobState	Exportera jobbstatus, projektmetadata och tillgångar.
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

AADToken

Det här är Azure Active Directory OAuth2 Flows. När du parkopplas med rollbaserad åtkomst i Azure kontroll kan den användas för att styra åtkomsten till Azure Maps REST-API:er. Rollbaserade åtkomstkontroller i Azure används för att ange åtkomst till ett eller flera Azure Maps-resurskonton eller underresurser. Alla användare, grupper eller tjänstens huvudnamn kan beviljas åtkomst via en inbyggd roll eller en anpassad roll som består av en eller flera behörigheter till Azure Maps REST-API:er.

För att implementera scenarier rekommenderar vi att du visar autentiseringsbegrepp. Sammanfattningsvis tillhandahåller den här säkerhetsdefinitionen en lösning för modellering av program via objekt som kan få åtkomstkontroll för specifika API:er och omfång.

Anteckningar

• Den här säkerhetsdefinitionen kräver användningen av x-ms-client-id-huvudet för att ange vilken Azure Maps-resurs programmet begär åtkomst till. Detta kan hämtas från Maps-hanterings-API:et.

Authorization URL är specifik för den offentliga Azure-molninstansen. Nationella moln har unika auktoriserings-URL:er och Azure Active Directory-konfigurationer. * Den rollbaserade åtkomstkontrollen i Azure konfigureras från Azure-hanteringsplan via Azure-portalen, PowerShell, CLI, Azure SDK:er eller REST-API:er. * Användning av Azure Maps Web SDK möjliggör konfigurationsbaserad konfiguration av ett program för flera användningsfall.

• För närvarande har Azure Active Directory v1.0 eller v2.0 stöd för Arbete, Skola och Gäster men stöder inte personliga konton.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

En prenumerationsnyckel för en språktjänstresurs.

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

HTTP

POST {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/:export?api-version=2023-04-15-preview

Exempelsvar

Statuskod:

200

{
  "errors": [],
  "createdDateTime": "2021-05-01T17:21:14Z",
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded",
  "resultUrl": "https://<resource-endpoint>/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2023-04-15-preview"
}

Statuskod:

202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2023-04-15-preview

Definitioner

Name	Description
assetKind	Typ av projektets tillgång.
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
ExportJobState	Exportera jobbstatus, projektmetadata och tillgångar.
format	Format för import eller export av kunskapsbas.
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.
jobStatus	Jobbstatus.

assetKind

Typ av projektets tillgång.

Name	Typ	Description
qnas	string
synonyms	string

Error

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

Felkod som kan läsas av människor.

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

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

ExportJobState

Exportera jobbstatus, projektmetadata och tillgångar.

Name	Typ	Description
createdDateTime	string
errors	Error[]	Felobjektet.
expirationDateTime	string
jobId	string
lastUpdatedDateTime	string
resultUrl	string	URL för att ladda ned resultatet av exportjobbet.
status	jobStatus	Jobbstatus.

format

Format för import eller export av kunskapsbas.

Name	Typ	Description
excel	string	Exportera eller importera kunskapsbasreplik, 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 kunskapsbasreplik, inklusive alla tillgångar och metadata i Excel-format.

InnerErrorCode

Felkod som kan läsas av människor.

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

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.

jobStatus

Jobbstatus.

Name	Typ	Description
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string