共用方式為

Question Answering Projects - Get Update Qnas Status

服務:
Azure AI Services
API 版本:
2023-04-01

取得更新 QnAs 作業的狀態。

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

URI 參數

名稱 位於 必要 類型 Description
Endpoint
 path True

string (uri)

支持的認知服務終結點（例如，https://< resource-name.api.cognitiveservices.azure.com>）。
jobId
 path True

string

工作 ID。
projectName
 path True

string

maxLength: 100
pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$

專案的名稱。
api-version
 query True

string

minLength: 1

用於此作業的 API 版本。

回應

名稱 類型 Description
200 OK

QuestionAnsweringAuthoringUpdateQnasJobState

要求已成功。
Other Status Codes

ErrorResponse

未預期的錯誤回應。

標題

x-ms-error-code: string

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
https://cognitiveservices.azure.com/.default

範例

Successful query

範例要求

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

範例回覆

狀態碼:
200 
{
  "createdDateTime": "2021-05-01T17:21:14Z",
  "errors": [],
  "expirationDateTime": "2021-05-01T17:21:14Z",
  "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a",
  "lastUpdatedDateTime": "2021-05-01T17:21:14Z",
  "status": "succeeded"
}

定義

名稱 Description
Azure.Core.Foundations.Error

error 物件。
Azure.Core.Foundations.InnerError

物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。
Error

error 物件。
ErrorCode

人類可讀取的錯誤碼。
ErrorResponse

錯誤回應。
InnerErrorCode

人類可讀取的錯誤碼。
InnerErrorModel

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
jobStatus

工作狀態。
QuestionAnsweringAuthoringUpdateQnasJobState

工作狀態代表工作中繼資料和任何錯誤。

Azure.Core.Foundations.Error

Object

error 物件。

名稱 類型 Description
code

string

其中一組伺服器定義的錯誤碼。
details

Azure.Core.Foundations.Error[]

導致此錯誤之特定錯誤的詳細數據陣列。
innererror

Azure.Core.Foundations.InnerError

物件，包含與目前對象有關錯誤更具體的資訊。
message

string

錯誤的人類可讀取表示法。
target

string

錯誤的目標。

Azure.Core.Foundations.InnerError

Object

物件，包含有關錯誤的更特定資訊。 根據 Azure REST API 準則 - https://aka.ms/AzureRestApiGuidelines#handling-errors。

名稱 類型 Description
code

string

其中一組伺服器定義的錯誤碼。
innererror

Azure.Core.Foundations.InnerError

內部錯誤。

Error

Object

error 物件。

名稱 類型 Description
code

ErrorCode

其中一組伺服器定義的錯誤碼。
details

Error[]

導致此錯誤之特定錯誤的詳細數據陣列。
innererror

InnerErrorModel

物件，包含與目前對象有關錯誤更具體的資訊。
message

string

錯誤的人類可讀取表示法。
target

string

錯誤的目標。

ErrorCode

列舉型別

人類可讀取的錯誤碼。

值 Description
InvalidRequest

要求錯誤無效
InvalidArgument

無效的自變數錯誤
Unauthorized

未經授權的存取錯誤
Forbidden

禁止存取錯誤
NotFound

找不到錯誤
ProjectNotFound

找不到項目錯誤
OperationNotFound

找不到作業錯誤
AzureCognitiveSearchNotFound

Azure 認知搜尋找不到錯誤
AzureCognitiveSearchIndexNotFound

Azure 認知搜尋索引找不到錯誤
TooManyRequests

要求太多錯誤
AzureCognitiveSearchThrottling

Azure 認知搜尋節流錯誤
AzureCognitiveSearchIndexLimitReached

Azure 認知搜尋索引限制已達錯誤
InternalServerError

內部伺服器錯誤
ServiceUnavailable

服務無法使用錯誤
Timeout

逾時錯誤
QuotaExceeded

超過配額錯誤
Conflict

衝突錯誤
Warning

警告錯誤

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
error

Error

error 物件。

InnerErrorCode

列舉型別

人類可讀取的錯誤碼。

值 Description
InvalidRequest

要求錯誤無效
InvalidParameterValue

無效的參數值錯誤
KnowledgeBaseNotFound

知識庫找不到錯誤
AzureCognitiveSearchNotFound

Azure 認知搜尋找不到錯誤
AzureCognitiveSearchThrottling

Azure 認知搜尋節流錯誤
ExtractionFailure

擷取失敗錯誤
InvalidRequestBodyFormat

無效的要求本文格式錯誤
EmptyRequest

空白要求錯誤
MissingInputDocuments

遺漏輸入文件錯誤
InvalidDocument

檔錯誤無效
ModelVersionIncorrect

模型版本不正確錯誤
InvalidDocumentBatch

檔批次錯誤無效
UnsupportedLanguageCode

不支援的語言代碼錯誤
InvalidCountryHint

無效的國家/地區提示錯誤

InnerErrorModel

Object

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱 類型 Description
code

InnerErrorCode

其中一組伺服器定義的錯誤碼。
details

object

錯誤詳細數據。
innererror

InnerErrorModel

物件，包含與目前對象有關錯誤更具體的資訊。
message

string

錯誤訊息。
target

string

錯誤目標。

jobStatus

列舉型別

工作狀態。

值 Description
notStarted
running
succeeded
failed
cancelled
cancelling
partiallyCompleted

QuestionAnsweringAuthoringUpdateQnasJobState

Object

工作狀態代表工作中繼資料和任何錯誤。

名稱 類型 Description
createdDateTime

string (date-time)

工作的建立日期時間。
errors

Azure.Core.Foundations.Error[]

執行作業時遇到的錯誤。
expirationDateTime

string (date-time)

工作的到期日、時間。
jobId

string

工作 ID。
lastUpdatedDateTime

string (date-time)

上次更新工作的日期。
status

jobStatus

工作狀態。