Question Answering Projects - Get Deploy Status

Tjänst:

Azure AI Services

API-version:

2021-10-01

Hämtar status för ett distribuerat jobb.

GET {Endpoint}/language/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}?api-version=2021-10-01

URI-parametrar

Name	I	Obligatorisk	Typ	Description
deploymentName	path	True	string	Namnet på den specifika distributionen av projektet som ska användas.
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Jobb-ID.
projectName	path	True	string maxLength: 100	Namnet på projektet som ska användas.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

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

Svar

Name	Typ	Description
200 OK	JobState	Distribuera jobbtillstånd.
Other Status Codes	ErrorResponse	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

Exempel

Successful query

Exempelbegäran

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1/deployments/production/jobs/job1?api-version=2021-10-01

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

Definitioner

Name	Description
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
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.
JobState	Jobbtillståndet representerar jobbmetadata och eventuella fel.
jobStatus	Jobbstatus.

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.

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.

JobState

Objekt

Jobbtillståndet representerar jobbmetadata och eventuella fel.

Name	Typ	Description
createdDateTime	string (date-time)
errors	Error[]	Felobjektet.
expirationDateTime	string (date-time)
jobId	string
lastUpdatedDateTime	string (date-time)
status	jobStatus	Jobbstatus.

jobStatus

Uppräkning

Jobbstatus.

Värde	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded