你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点（例如 https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	要使用的项目的名称。
api-version	query	True	string	客户端 API 版本。

请求头

名称	必需	类型	说明
Ocp-Apim-Subscription-Key	True	string	语言服务资源的订阅密钥。

响应

名称	类型	说明
200 OK	TextAnalysisAuthoringProjectMetadata	项目的元数据。
Other Status Codes	ErrorResponse	错误响应。

安全性

Ocp-Apim-Subscription-Key

语言服务资源的订阅密钥。

类型: apiKey
在: 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"
}

定义

名称	说明
Error	错误对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectKind	项目类型。
TextAnalysisAuthoringProjectMetadata	表示项目的元数据。

Error

Object

错误对象。

名称	类型	说明
code	ErrorCode	服务器定义的错误代码集之一。
details	Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

ErrorCode

枚举

人工可读错误代码。

值	说明
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

错误响应。

名称	类型	说明
error	Error	错误对象。

InnerErrorCode

枚举

人工可读错误代码。

值	说明
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名称	类型	说明
code	InnerErrorCode	服务器定义的错误代码集之一。
details	object	错误详细信息。
innererror	InnerErrorModel	包含与当前对象有关错误的更具体信息的对象。
message	string	错误信息。
target	string	错误目标。

ProjectKind

枚举

项目类型。

值	说明
CustomEntityRecognition	若要生成提取模型，以使用自己的数据标识域类别。
CustomMultiLabelClassification	用于生成分类模型以使用自己的数据对文本进行分类。 每个文件可以有一个或多个标签。 例如，文件 1 分类为 A、B 和 C，文件 2 分类为 B 和 C。
CustomSingleLabelClassification	用于生成分类模型以使用自己的数据对文本进行分类。 每个文件将只有一个标签。 例如，文件 1 被分类为 A，文件 2 分类为 B。

TextAnalysisAuthoringProjectMetadata

Object

表示项目的元数据。

名称	类型	说明
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	存储容器名称。