共用方式為

Miscellaneous Operations - Get Document Classifier Copy To Operation

  • 參考
服務:
Azure AI Services
API 版本:
2024-11-30

取得作業資訊。

GET {endpoint}/documentintelligence/operations/{operationId}?_overload=getDocumentClassifierCopyToOperation&api-version=2024-11-30

URI 參數

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

string

uri

Document Intelligence 服務端點。
operationId
 path True

string

作業標識碼
api-version
 query True

string

要用於這項作業的 API 版本。

要求標頭

名稱 必要 類型 Description
x-ms-client-request-id

string

uuid

要求不透明、全域唯一、用戶端產生的字串標識碼。

回應

名稱 類型 Description
200 OK

DocumentClassifierCopyToOperationDetails

要求已成功。

標題

x-ms-client-request-id: string
Other Status Codes

DocumentIntelligenceErrorResponse

未預期的錯誤回應。

安全性

Ocp-Apim-Subscription-Key

類型: apiKey
位於: header

OAuth2Auth

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

範圍

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

範例

Get Operation - Document Classifier Copy To

範例要求

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/operations/b704bb00-d130-4f3f-a1d8-ca96de3eabb4?_overload=getDocumentClassifierCopyToOperation&api-version=2024-11-30

範例回覆

狀態碼:
200 
{
  "operationId": "b704bb00-d130-4f3f-a1d8-ca96de3eabb4",
  "status": "succeeded",
  "percentCompleted": 100,
  "createdDateTime": "2021-09-23T09:12:57Z",
  "lastUpdatedDateTime": "2021-09-23T09:13:01Z",
  "kind": "documentClassifierCopyTo",
  "resourceLocation": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myCustomClassifier",
  "result": {
    "classifierId": "myCustomClassifier",
    "description": "Classifier description",
    "createdDateTime": "2022-07-30T00:00:00Z",
    "expirationDateTime": "2023-01-01T00:00:00Z",
    "apiVersion": "2024-11-30",
    "docTypes": {
      "formA": {
        "azureBlobSource": {
          "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
          "prefix": "formADocs/"
        }
      },
      "formB": {
        "azureBlobFileListSource": {
          "containerUrl": "https://myStorageAccount.blob.core.windows.net/myContainer",
          "fileList": "formB.jsonl"
        }
      }
    }
  }
}

定義

名稱 Description
AzureBlobContentSource

Azure Blob 記憶體內容。
AzureBlobFileListContentSource

Azure Blob 記憶體中的檔案清單。
ClassifierDocumentTypeDetails

分類器檔類型資訊。
ContentSourceKind

內容類型。
DocumentClassifierCopyToOperationDetails

取得作業回應物件。
DocumentClassifierDetails

檔分類器資訊。
DocumentIntelligenceError

error 物件。
DocumentIntelligenceErrorResponse

錯誤回應物件。
DocumentIntelligenceInnerError

物件，包含有關錯誤的更特定資訊。
DocumentIntelligenceOperationStatus

作業狀態。
DocumentIntelligenceWarning

error 物件。
OperationKind

作業類型。

AzureBlobContentSource

Azure Blob 記憶體內容。

名稱 類型 Description
containerUrl

string

Azure Blob 記憶體容器 URL。
prefix

string

Blob 名稱前置詞。

AzureBlobFileListContentSource

Azure Blob 記憶體中的檔案清單。

名稱 類型 Description
containerUrl

string

Azure Blob 記憶體容器 URL。
fileList

string

指定文件子集之容器內的 JSONL 檔案路徑。

ClassifierDocumentTypeDetails

分類器檔類型資訊。

名稱 類型 Description
azureBlobFileListSource

AzureBlobFileListContentSource

Azure Blob 記憶體檔案清單，指定分類器檔類型的定型數據。 必須指定 azureBlobSource 或 azureBlobFileListSource。
azureBlobSource

AzureBlobContentSource

Azure Blob 記憶體位置，其中包含分類器檔類型的定型數據。 必須指定 azureBlobSource 或 azureBlobFileListSource。
sourceKind

ContentSourceKind

定型數據源的類型。

ContentSourceKind

內容類型。

名稱 類型 Description
azureBlob

string

Azure Blob 記憶體容器內路徑中的檔案。
azureBlobFileList

string

指定 Azure Blob 記憶體容器中個別檔案的檔案清單。
base64

string

透過Base64編碼表示的內容。
url

string

特定 URL 上的內容。

DocumentClassifierCopyToOperationDetails

取得作業回應物件。

名稱 類型 Description
apiVersion

string

用來建立此作業的 API 版本。
createdDateTime

string

建立作業的日期和時間 （UTC）。
error

DocumentIntelligenceError

發生錯誤。
kind string:

documentClassifierCopyTo

作業類型。
lastUpdatedDateTime

string

上次更新狀態的日期和時間 （UTC）。
operationId

string

作業標識碼
percentCompleted

integer

作業進度（0-100）。
resourceLocation

string

此作業的目標資源URL。
result

DocumentClassifierDetails

作業成功時的結果。
status

DocumentIntelligenceOperationStatus

作業狀態。 notStarted、running、completed 或 failed
tags

object

與檔模型相關聯的索引鍵/值標籤屬性清單。

DocumentClassifierDetails

檔分類器資訊。

名稱 類型 Description
apiVersion

string

用來建立此文件分類器的 API 版本。
baseClassifierId

string

分類器訓練的基底分類器標識碼。
classifierId

string

唯一的檔分類器名稱。
createdDateTime

string

建立文件分類器的日期和時間 （UTC）。
description

string

檔分類器描述。
docTypes

<string,  ClassifierDocumentTypeDetails>

要分類的檔案類型清單。
expirationDateTime

string

檔分類器到期的日期和時間（UTC）。
modifiedDateTime

string

上次修改檔模型的日期和時間（UTC）。
warnings

DocumentIntelligenceWarning[]

建置分類器時遇到的警告清單。

DocumentIntelligenceError

error 物件。

名稱 類型 Description
code

string

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

DocumentIntelligenceError[]

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

DocumentIntelligenceInnerError

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

string

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

string

錯誤的目標。

DocumentIntelligenceErrorResponse

錯誤回應物件。

名稱 類型 Description
error

DocumentIntelligenceError

錯誤資訊。

DocumentIntelligenceInnerError

物件，包含有關錯誤的更特定資訊。

名稱 類型 Description
code

string

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

DocumentIntelligenceInnerError

內部錯誤。
message

string

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

DocumentIntelligenceOperationStatus

作業狀態。

名稱 類型 Description
canceled

string

作業已取消。
failed

string

作業失敗。
notStarted

string

作業尚未啟動。
running

string

作業正在進行中。
skipped

string

作業已略過。
succeeded

string

作業已成功。

DocumentIntelligenceWarning

error 物件。

名稱 類型 Description
code

string

其中一組伺服器定義的警告碼。
message

string

人類可讀取的警告表示法。
target

string

錯誤的目標。

OperationKind

作業類型。

名稱 類型 Description
documentClassifierBuild

string

建置新的自定義分類器模型。
documentClassifierCopyTo

string

將現有的檔分類器複製到可能不同的資源、區域或訂用帳戶。
documentModelBuild

string

建置新的自定義檔模型。
documentModelCompose

string

從現有的模型撰寫新的自定義檔模型。
documentModelCopyTo

string

將現有的檔模型複製到可能不同的資源、區域或訂用帳戶。