Text Analysis Authoring - Create Project

참조

서비스:: Azure AI Services

API 버전:: 2023-04-01

리소스에 적용되는 가장 기본적인 작업입니다.

PATCH {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2023-04-01

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 버전입니다.

요청 본문

Media Types: "application/merge-patch+json"

Name	필수	형식	Description
language	True	string	프로젝트 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
projectKind	True	ProjectKind	프로젝트 종류입니다.
projectName	True	string	새 프로젝트 이름입니다.
storageInputContainerName	True	string	스토리지 컨테이너 이름입니다.
description		string	프로젝트 설명입니다.
multilingual		boolean	프로젝트를 여러 언어로 사용할지 여부입니다.
settings		ProjectSettings	프로젝트 설정입니다.

응답

Name	형식	Description
200 OK	TextAnalysisAuthoringProjectMetadata	요청이 성공했습니다.
201 Created	TextAnalysisAuthoringProjectMetadata	요청이 성공했고 결과적으로 새 리소스가 생성되었습니다.
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 Create Project

샘플 요청

HTTP

PATCH {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2023-04-01

{
  "projectName": "LoanAgreements",
  "language": "en",
  "projectKind": "CustomEntityRecognition",
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "multilingual": false,
  "storageInputContainerName": "loanagreements"
}

샘플 응답

상태 코드:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

상태 코드:: 200

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "lastTrainedDateTime": "2022-04-18T14:14:28Z",
  "lastDeployedDateTime": "2022-04-18T14:49:01Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "projectName": "LoanAgreements",
  "multilingual": false,
  "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.",
  "language": "en"
}

정의

Name	Description
CreateProjectOptions	프로젝트를 만들거나 업데이트하는 데 사용되는 옵션을 나타냅니다.
Error	오류 개체입니다.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind
ProjectSettings	프로젝트 동작을 정의하는 데 사용되는 설정을 나타냅니다.
TextAnalysisAuthoringProjectMetadata	프로젝트의 메타데이터를 나타냅니다.

CreateProjectOptions

프로젝트를 만들거나 업데이트하는 데 사용되는 옵션을 나타냅니다.

Name	형식	Description
description	string	프로젝트 설명입니다.
language	string	프로젝트 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
multilingual	boolean	프로젝트를 여러 언어로 사용할지 여부입니다.
projectKind	ProjectKind	프로젝트 종류입니다.
projectName	string	새 프로젝트 이름입니다.
settings	ProjectSettings	프로젝트 설정입니다.
storageInputContainerName	string	스토리지 컨테이너 이름입니다.

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	오류 대상입니다.

ProjectKind

Name	형식	Description
CustomEntityRecognition	string	사용자 고유의 데이터를 사용하여 도메인 범주를 식별하는 추출 모델을 빌드합니다.
CustomMultiLabelClassification	string	사용자 고유의 데이터를 사용하여 텍스트를 분류하는 분류 모델을 빌드하는 경우 각 파일에는 하나 이상의 레이블이 있을 수 있습니다. 예를 들어 파일 1은 A, B 및 C로 분류되고 파일 2는 B 및 C로 분류됩니다.
CustomSingleLabelClassification	string	사용자 고유의 데이터를 사용하여 텍스트를 분류하는 분류 모델을 빌드하는 경우 각 파일에는 레이블이 하나만 있습니다. 예를 들어 파일 1은 A로 분류되고 파일 2는 B로 분류됩니다.

ProjectSettings

프로젝트 동작을 정의하는 데 사용되는 설정을 나타냅니다.

Name	형식	Description
confidenceThreshold	number	신뢰도가 가장 높은 클래스의 임계값으로, 예측이 자동으로 "없음"으로 변경됩니다. 임계값은 0에서 1 사이여야 합니다.

TextAnalysisAuthoringProjectMetadata

프로젝트의 메타데이터를 나타냅니다.

Name	형식	Description
createdDateTime	string	프로젝트 생성 날짜/시간을 나타냅니다.
description	string	프로젝트 설명입니다.
language	string	프로젝트 언어입니다. 이는 언어의 BCP-47 표현입니다. 예를 들어 영어에 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다.
lastDeployedDateTime	string	프로젝트 마지막 배포 날짜/시간을 나타냅니다.
lastModifiedDateTime	string	프로젝트의 마지막 수정 날짜/시간을 나타냅니다.
lastTrainedDateTime	string	프로젝트의 마지막 학습 날짜/시간을 나타냅니다.
multilingual	boolean	프로젝트를 여러 언어로 사용할지 여부입니다.
projectKind	ProjectKind	프로젝트 종류입니다.
projectName	string	새 프로젝트 이름입니다.
settings	ProjectSettings	프로젝트 설정입니다.
storageInputContainerName	string	스토리지 컨테이너 이름입니다.

다음을 통해 공유