Delen via


Question Answering Projects - Get Export Status

Hiermee haalt u de status van een exporttaak op, zodra de taak is voltooid, worden de metagegevens en assets van het project geretourneerd.

GET {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}?api-version=2023-04-01

URI-parameters

Name In Vereist Type Description
Endpoint
path True

string

Ondersteund Cognitive Services-eindpunt (bijvoorbeeld https://.api.cognitiveservices.azure.com).

jobId
path True

string

Taak-id.

projectName
path True

string

De naam van het project dat moet worden gebruikt.

api-version
query True

string

Client-API-versie.

Antwoorden

Name Type Description
200 OK

ExportJobState

Taakstatus, projectmetagegevens en assets exporteren.

Other Status Codes

ErrorResponse

Foutreactie.

Beveiliging

AADToken

Dit zijn de Azure Active Directory OAuth2-stromen . In combinatie met op rollen gebaseerd toegangsbeheer van Azure kan het worden gebruikt om de toegang tot Azure Maps REST API's te beheren. Op rollen gebaseerd toegangsbeheer van Azure wordt gebruikt om toegang tot een of meer Azure Maps resourceaccount of subresources aan te wijzen. Elke gebruiker, groep of service-principal kan toegang krijgen via een ingebouwde rol of een aangepaste rol die bestaat uit een of meer machtigingen voor Azure Maps REST API's.

Als u scenario's wilt implementeren, raden we u aan om verificatieconcepten te bekijken. Samengevat biedt deze beveiligingsdefinitie een oplossing voor het modelleren van toepassingen via objecten die toegangsbeheer kunnen hebben voor specifieke API's en bereiken.

Notities

  • Deze beveiligingsdefinitie vereist het gebruik van de x-ms-client-id header om aan te geven tot welke Azure Maps resource de toepassing toegang aanvraagt. Dit kan worden verkregen via de Beheer-API van Maps.

De Authorization URL is specifiek voor het azure-exemplaar van de openbare cloud. Onafhankelijke clouds hebben unieke autorisatie-URL's en Azure Active Directory-configuraties. * Op rollen gebaseerd toegangsbeheer van Azure wordt geconfigureerd vanuit het Azure-beheervlak via Azure Portal, PowerShell, CLI, Azure SDK's of REST API's. * Gebruik van de Azure Maps Web SDK maakt configuratie van een toepassing mogelijk voor meerdere gebruiksscenario's.

  • Momenteel ondersteunt Azure Active Directory v1.0 of v2.0 werk, school en gasten, maar geen persoonlijke accounts.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Ocp-Apim-Subscription-Key

Een abonnementssleutel voor een taalserviceresource.

Type: apiKey
In: header

Voorbeelden

Successful query

Voorbeeldaanvraag

GET {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2023-04-01

Voorbeeldrespons

{
  "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-01"
}

Definities

Name Description
Error

Het foutobject.

ErrorCode

Door mensen leesbare foutcode.

ErrorResponse

Foutreactie.

ExportJobState

Taakstatus, projectmetagegevens en assets exporteren.

InnerErrorCode

Door mensen leesbare foutcode.

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.

jobStatus

Taakstatus.

Error

Het foutobject.

Name Type Description
code

ErrorCode

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

InnerErrorModel

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

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

Foutreactie.

Name Type Description
error

Error

Het foutobject.

ExportJobState

Taakstatus, projectmetagegevens en assets exporteren.

Name Type Description
createdDateTime

string

errors

Error[]

Het foutobject.

expirationDateTime

string

jobId

string

lastUpdatedDateTime

string

resultUrl

string

URL voor het downloaden van het resultaat van de exporttaak.

status

jobStatus

Taakstatus.

InnerErrorCode

Door mensen leesbare foutcode.

Name Type 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

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

InnerErrorCode

Een van een door de server gedefinieerde set foutcodes.

details

object

Foutdetails.

innererror

InnerErrorModel

Een object met specifiekere informatie dan het huidige object over de fout.

message

string

Foutbericht.

target

string

Foutdoel.

jobStatus

Taakstatus.

Name Type Description
cancelled

string

cancelling

string

failed

string

notStarted

string

partiallyCompleted

string

running

string

succeeded

string