Text Analysis Authoring - Get Project

서비스:: Azure AI Services

API 버전:: 2022-05-01

프로젝트의 세부 정보를 가져옵니다.

GET {Endpoint}/language/authoring/analyze-text/projects/{projectName}?api-version=2022-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
Endpoint	path	True	string	지원되는 Cognitive Services 엔드포인트(예: https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100	사용할 프로젝트의 이름입니다.
api-version	query	True	string	클라이언트 API 버전.

요청 헤더

Name	필수	형식	Description
Ocp-Apim-Subscription-Key	True	string	언어 서비스 리소스에 대한 구독 키입니다.

응답

Name	형식	Description
200 OK	TextAnalysisAuthoringProjectMetadata	프로젝트의 메타데이터입니다.
Other Status Codes	ErrorResponse	오류 응답입니다.

보안

Ocp-Apim-Subscription-Key

언어 서비스 리소스에 대한 구독 키입니다.

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

예제

Successful Get Project

샘플 요청

HTTP

GET {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements?api-version=2022-05-01

샘플 응답

상태 코드:: 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
Error	오류 개체입니다.
ErrorCode	사람이 읽을 수 있는 오류 코드입니다.
ErrorResponse	오류 응답입니다.
InnerErrorCode	사람이 읽을 수 있는 오류 코드입니다.
InnerErrorModel	오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind	프로젝트 종류입니다.
TextAnalysisAuthoringProjectMetadata	프로젝트의 메타데이터를 나타냅니다.

Error

Object

오류 개체입니다.

Name	형식	Description
code	ErrorCode	서버에서 정의한 오류 코드 집합 중 하나입니다.
details	Error[]	이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다.
innererror	InnerErrorModel	오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다.
message	string	사람이 읽을 수 있는 오류 표현입니다.
target	string	오류의 대상입니다.

ErrorCode

열거형

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

값	Description
InvalidRequest
InvalidArgument
Unauthorized
Forbidden
NotFound
ProjectNotFound
OperationNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchIndexNotFound
TooManyRequests
AzureCognitiveSearchThrottling
AzureCognitiveSearchIndexLimitReached
InternalServerError
ServiceUnavailable
Timeout
QuotaExceeded
Conflict
Warning

ErrorResponse

Object

오류 응답입니다.

Name	형식	Description
error	Error	오류 개체입니다.

InnerErrorCode

열거형

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

값	Description
InvalidRequest
InvalidParameterValue
KnowledgeBaseNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidRequestBodyFormat
EmptyRequest
MissingInputDocuments
InvalidDocument
ModelVersionIncorrect
InvalidDocumentBatch
UnsupportedLanguageCode
InvalidCountryHint

InnerErrorModel

Object

오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. 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

열거형

프로젝트 종류입니다.

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

TextAnalysisAuthoringProjectMetadata

Object

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

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