Question Answering Projects - Get Deploy Status

Service:

Cognitive Services

API Version:

2021-10-01

Lekéri az Üzembe helyezési feladat állapotát.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
deploymentName	path	True	string	A használni kívánt projekt adott üzembe helyezésének neve.
Endpoint	path	True	string	Támogatott Cognitive Services-végpont (pl. https://.api.cognitiveservices.azure.com).
jobId	path	True	string	Feladatazonosító.
projectName	path	True	string	A használni kívánt projekt neve.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
Ocp-Apim-Subscription-Key	True	string

Válaszok

Name	Típus	Description
200 OK	JobState	Feladatállapot üzembe helyezése.
Other Status Codes	ErrorResponse	Hibaválasz.

Biztonság

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Példák

Successful query

Sample Request

HTTP

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

Sample Response

Status code:

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

Definíciók

Name	Description
Error	A hibaobjektum.
ErrorCode	Emberi olvasásra alkalmas hibakód.
ErrorResponse	Hibaválasz.
InnerErrorCode	Emberi olvasásra alkalmas hibakód.
InnerErrorModel	Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobState	A feladat állapota a feladat metaadatait és az esetleges hibákat jelöli.
jobStatus	Feladat állapota.

Error

A hibaobjektum.

Name	Típus	Description
code	ErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	Error[]	A jelentett hibához vezető konkrét hibák részleteinek tömbje.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	A hiba emberi olvasásra alkalmas ábrázolása.
target	string	A hiba célja.

ErrorCode

Emberi olvasásra alkalmas hibakód.

Name	Típus	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

Hibaválasz.

Name	Típus	Description
error	Error	A hibaobjektum.

InnerErrorCode

Emberi olvasásra alkalmas hibakód.

Name	Típus	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Egy objektum, amely részletesebb információkat tartalmaz a hibáról. A Microsoft One API irányelvei szerint – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Típus	Description
code	InnerErrorCode	A kiszolgáló által definiált hibakódok egyike.
details	object	Hiba részletei.
innererror	InnerErrorModel	Egy objektum, amely az aktuális objektumnál pontosabb információkat tartalmaz a hibáról.
message	string	Hibaüzenet.
target	string	Hibacél.

JobState

A feladat állapota a feladat metaadatait és az esetleges hibákat jelöli.

Name	Típus	Description
createdDateTime	string
errors	Error[]	A hibaobjektum.
expirationDateTime	string
jobId	string
lastUpdatedDateTime	string
status	jobStatus	Feladat állapota.

jobStatus

Feladat állapota.

Name	Típus	Description
cancelled	string
cancelling	string
failed	string
notStarted	string
partiallyCompleted	string
running	string
succeeded	string