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 매개 변수

Name In(다음 안에) 필수 형식 Description
Endpoint
 path True

string

url

지원되는 Cognitive Services 엔드포인트(예: 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이면 기본 동작은 현재 작업 복사본을 내보내는 것입니다.

응답

Name 형식 Description
202 Accepted

처리를 위해 요청이 수락되었지만 처리가 아직 완료되지 않았습니다.

헤더

Operation-Location: string
Other Status Codes

ErrorResponse

예기치 않은 오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

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

OAuth2Auth

형식: oauth2
Flow: accessCode
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize
토큰 URL: https://login.microsoftonline.com/common/oauth2/token

범위

Name 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

정의

Name Description
Error

오류 개체입니다.
ErrorCode

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

오류 응답입니다.
InnerErrorCode

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

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

Error

오류 개체입니다.

Name 형식 Description
code

ErrorCode

서버에서 정의한 오류 코드 집합 중 하나입니다.
details

Error[]

이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror

InnerErrorModel

오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message

string

사람이 읽을 수 있는 오류 표현입니다.
target

string

오류의 대상입니다.

ErrorCode

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

Name 형식 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

오류 응답입니다.

Name 형식 Description
error

Error

오류 개체입니다.

InnerErrorCode

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

Name 형식 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 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

오류 대상입니다.

StringIndexType

Name 형식 Description
Utf16CodeUnit

string

오프셋 및 길이 값은 UTF-16 코드 단위에 해당합니다. 애플리케이션이 유니코드를 지원하는 언어(예: Java, JavaScript)로 작성된 경우 이 옵션을 사용합니다.