Text Analysis Authoring - Export

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

觸發作業以匯出項目的數據。

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit
含選擇性參數: 
POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit&assetKind={assetKind}&trainedModelLabel={trainedModelLabel}

URI 參數

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

string

url

支援的認知服務端點 （例如，https://.api.cognitiveservices.azure.com).
projectName
 path True

string

要使用的項目名稱。
api-version
 query True

string

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

StringIndexType

指定用來解譯字串位移的方法。 如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。
assetKind
 query

string

要導出的資產種類。
trainedModelLabel
 query

string

要導出的定型模型標籤。 如果 trainedModelLabel 為 null，預設行為是匯出目前的工作複本。

回應

名稱 類型 Description
202 Accepted

要求已接受進行處理，但尚未完成處理。

標題

Operation-Location: string
Other Status Codes

ErrorResponse

未預期的錯誤回應。

安全性

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

範例

Successful Export Project

範例要求

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:export?api-version=2023-04-01&stringIndexType=Utf16CodeUnit

範例回覆

狀態碼:
202 
operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01

定義

名稱 Description
Error

error 物件。
ErrorCode

人類可讀取的錯誤碼。
ErrorResponse

錯誤回應。
InnerErrorCode

人類可讀取的錯誤碼。
InnerErrorModel

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

Error

error 物件。

名稱 類型 Description
code

ErrorCode

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

Error[]

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

InnerErrorModel

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

string

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

string

錯誤的目標。

ErrorCode

人類可讀取的錯誤碼。

名稱 類型 Description
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Conflict

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

QuotaExceeded

string

ServiceUnavailable

string

Timeout

string

TooManyRequests

string

Unauthorized

string

Warning

string

ErrorResponse

錯誤回應。

名稱 類型 Description
error

Error

error 物件。

InnerErrorCode

人類可讀取的錯誤碼。

名稱 類型 Description
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

InnerErrorModel

物件，包含有關錯誤的更特定資訊。 根據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

錯誤目標。

StringIndexType

名稱 類型 Description
Utf16CodeUnit

string

位移和長度值會對應至UTF-16程式代碼單位。 如果您的應用程式是以支援 Unicode 的語言撰寫，例如 Java、JavaScript，請使用此選項。