Question Answering Projects - Get Deploy Status

서비스:

Azure AI Services

API 버전:

2021-10-01

배포 작업의 상태를 가져옵니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
deploymentName	path	True	string	사용할 프로젝트의 특정 배포 이름입니다.
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com).
jobId	path	True	string	작업 ID입니다.
projectName	path	True	string maxLength: 100	사용할 프로젝트의 이름입니다.
api-version	query	True	string	클라이언트 API 버전입니다.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string

응답

Name	형식	Description
200 OK	JobState	작업 상태를 배포합니다.
Other Status Codes	ErrorResponse	오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

형식: apiKey
In(다음 안에): header

예제

Successful query

샘플 요청

HTTP

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

샘플 응답

상태 코드:

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

정의

Name	Description
Error	오류 개체입니다.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobState	작업 상태는 작업 메타데이터 및 오류를 나타냅니다.
jobStatus	작업 상태.

Error

Object

오류 개체입니다.

Name	형식	Description
code	ErrorCode	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

ErrorCode

열거형

사람이 읽을 수 있는 오류 코드입니다.

값	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
error	Error	오류 개체입니다.

InnerErrorCode

열거형

사람이 읽을 수 있는 오류 코드입니다.

값	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	형식	Description
code	InnerErrorCode	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	object	오류 세부 정보입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

JobState

Object

작업 상태는 작업 메타데이터 및 오류를 나타냅니다.

Name	형식	Description
createdDateTime	string (date-time)
errors	Error[]	오류 개체입니다.
expirationDateTime	string (date-time)
jobId	string
lastUpdatedDateTime	string (date-time)
status	jobStatus	작업 상태.

jobStatus

열거형

작업 상태.

값	Description
cancelled
cancelling
failed
notStarted
partiallyCompleted
running
succeeded