Text Analysis Authoring - List Projects
기존 프로젝트를 Lists.
GET {Endpoint}/language/authoring/analyze-text/projects?api-version=2023-04-01
GET {Endpoint}/language/authoring/analyze-text/projects?top={top}&skip={skip}&maxpagesize={maxpagesize}&api-version=2023-04-01
URI 매개 변수
Name | In(다음 안에) | 필수 | 형식 | Description |
---|---|---|---|---|
Endpoint
|
path | True |
string |
지원되는 Cognitive Services 엔드포인트(예: https://.api.cognitiveservices.azure.com). |
api-version
|
query | True |
string |
클라이언트 API 버전입니다. |
maxpagesize
|
query |
integer int32 |
단일 응답에 포함할 최대 리소스 수입니다. |
|
skip
|
query |
integer int32 |
반환할 첫 번째 리소스의 컬렉션에 대한 오프셋입니다. |
|
top
|
query |
integer int32 |
컬렉션에서 반환할 최대 리소스 수입니다. |
응답
Name | 형식 | Description |
---|---|---|
200 OK |
프로젝트의 메타데이터입니다. |
|
Other Status Codes |
오류 응답입니다. |
보안
AADToken
Azure Active Directory OAuth2 흐름입니다. Azure 역할 기반 액세스 제어와 쌍을 이루는 경우 Azure Maps REST API에 대한 액세스를 제어하는 데 사용할 수 있습니다. Azure 역할 기반 액세스 제어는 하나 이상의 Azure Maps 리소스 계정 또는 하위 리소스에 대한 액세스를 지정하는 데 사용됩니다. 모든 사용자, 그룹 또는 서비스 주체는 기본 제공 역할 또는 REST API를 Azure Maps 하나 이상의 권한으로 구성된 사용자 지정 역할을 통해 액세스 권한을 부여할 수 있습니다.
시나리오를 구현하려면 인증 개념을 보는 것이 좋습니다. 요약하자면, 이 보안 정의는 특정 API 및 범위에 대한 액세스 제어가 가능한 개체를 통해 애플리케이션을 모델링하기 위한 솔루션을 제공합니다.
참고
- 이 보안 정의에서는 헤더를 사용하여 애플리케이션이
x-ms-client-id
액세스를 요청하는 Azure Maps 리소스를 나타내야 합니다. 이는 Maps 관리 API에서 가져올 수 있습니다.
Authorization URL
은 Azure 퍼블릭 클라우드 instance 관련됩니다. 소버린 클라우드에는 고유한 권한 부여 URL 및 Azure Active Directory 구성이 있습니다.
* Azure 역할 기반 액세스 제어는 Azure Portal, PowerShell, CLI, Azure SDK 또는 REST API를 통해 Azure 관리 평면에서 구성됩니다.
* Azure Maps 웹 SDK를 사용하면 여러 사용 사례에 대한 애플리케이션의 구성 기반 설정을 허용합니다.
- 현재 Azure Active Directory v1.0 또는 v2.0 은 회사, 학교 및 게스트를 지원하지만 개인 계정은 지원하지 않습니다.
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
Name | Description |
---|---|
https://cognitiveservices.azure.com/.default | https://cognitiveservices.azure.com/.default |
Ocp-Apim-Subscription-Key
언어 서비스 리소스에 대한 구독 키입니다.
형식:
apiKey
In(다음 안에):
header
예제
Successful List Projects
샘플 요청
GET {Endpoint}/language/authoring/analyze-text/projects?api-version=2023-04-01
샘플 응답
{
"value": [
{
"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"
},
{
"createdDateTime": "2022-04-18T14:03:12Z",
"lastModifiedDateTime": "2022-04-18T14:03:12Z",
"projectKind": "CustomMultiLabelClassification",
"storageInputContainerName": "loanagreements",
"projectName": "MoviesSummary",
"multilingual": false,
"description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".",
"language": "en"
}
],
"nextLink": null
}
정의
Name | Description |
---|---|
Error |
Error 개체. |
Error |
사람이 읽을 수 있는 오류 코드입니다. |
Error |
오류 응답입니다. |
Inner |
사람이 읽을 수 있는 오류 코드입니다. |
Inner |
오류에 대한 보다 구체적인 정보를 포함하는 개체입니다. Microsoft One API 지침에 따라 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses. |
Project |
프로젝트 종류입니다. |
Text |
프로젝트의 메타데이터를 나타냅니다. |
Text |
프로젝트 동작을 정의하는 데 사용되는 설정을 나타냅니다. |
Text |
검색된 프로젝트의 메타데이터 목록을 나타냅니다. |
Error
Error 개체.
Name | 형식 | Description |
---|---|---|
code |
서버 정의 오류 코드 집합 중 하나입니다. |
|
details |
Error[] |
이 보고된 오류로 이어진 특정 오류에 대한 세부 정보 배열입니다. |
innererror |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
|
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 |
서버 정의 오류 코드 집합 중 하나입니다. |
|
details |
object |
오류 세부 정보입니다. |
innererror |
오류에 대한 현재 개체보다 더 구체적인 정보를 포함하는 개체입니다. |
|
message |
string |
오류 메시지입니다. |
target |
string |
오류 대상입니다. |
ProjectKind
프로젝트 종류입니다.
Name | 형식 | Description |
---|---|---|
CustomEntityRecognition |
string |
사용자 고유의 데이터를 사용하여 도메인 범주를 식별하는 추출 모델을 빌드합니다. |
CustomMultiLabelClassification |
string |
사용자 고유의 데이터를 사용하여 텍스트를 분류하는 분류 모델을 빌드하는 경우 각 파일에는 하나 이상의 레이블이 있을 수 있습니다. 예를 들어 파일 1은 A, B 및 C로 분류되고 파일 2는 B 및 C로 분류됩니다. |
CustomSingleLabelClassification |
string |
사용자 고유의 데이터를 사용하여 텍스트를 분류하는 분류 모델을 빌드하는 경우 각 파일에는 레이블이 하나만 있습니다. 예를 들어 파일 1은 A로 분류되고 파일 2는 B로 분류됩니다. |
TextAnalysisAuthoringProjectMetadata
프로젝트의 메타데이터를 나타냅니다.
Name | 형식 | Description |
---|---|---|
createdDateTime |
string |
프로젝트 만들기 날짜/시간을 나타냅니다. |
description |
string |
프로젝트 설명입니다. |
language |
string |
프로젝트 언어입니다. 이는 BCP-47 언어 표현입니다. 예를 들어 영어의 경우 "en", 영어(영국)의 경우 "en-gb", 스페인어의 경우 "es"를 사용합니다. |
lastDeployedDateTime |
string |
프로젝트 마지막 배포 날짜/시간을 나타냅니다. |
lastModifiedDateTime |
string |
프로젝트 마지막 수정 날짜/시간을 나타냅니다. |
lastTrainedDateTime |
string |
프로젝트 마지막 학습 날짜/시간을 나타냅니다. |
multilingual |
boolean |
프로젝트를 여러 언어로 사용할지 여부입니다. |
projectKind |
프로젝트 종류입니다. |
|
projectName |
string |
새 프로젝트 이름입니다. |
settings |
프로젝트 설정입니다. |
|
storageInputContainerName |
string |
스토리지 컨테이너 이름입니다. |
TextAnalysisAuthoringProjectSettings
프로젝트 동작을 정의하는 데 사용되는 설정을 나타냅니다.
Name | 형식 | Description |
---|---|---|
confidenceThreshold |
number |
예측이 자동으로 "없음"으로 변경되는 신뢰도가 가장 높은 클래스의 임계값입니다. 임계값은 0에서 1 사이여야 합니다. |
TextAnalysisAuthoringProjectsMetadata
검색된 프로젝트의 메타데이터 목록을 나타냅니다.
Name | 형식 | Description |
---|---|---|
nextLink |
string |
다음 페이지 링크입니다. |
value |
프로젝트 목록입니다. |