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

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

名称	在	必需	类型	说明
Endpoint	path	True	string url	支持的认知服务终结点（例如 https://.api.cognitiveservices.azure.com).
projectName	path	True	string	新项目名称。
api-version	query	True	string	用于此操作的 API 版本。

请求正文

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

名称	必需	类型	说明
language	True	string	项目语言。这是语言的 BCP-47 表示形式。例如，将“en”用于英语，“en-gb”用于英语（英国），将“es”用于西班牙语等。
projectKind	True	ProjectKind	项目类型。
projectName	True	string	新项目名称。
storageInputContainerName	True	string	存储容器名称。
description		string	项目说明。
multilingual		boolean	项目是否用于多种语言。
settings		ProjectSettings	项目设置。

响应

名称	类型	说明
200 OK	TextAnalysisAuthoringProjectMetadata	请求已成功。
201 Created	TextAnalysisAuthoringProjectMetadata	请求已成功，因此创建了一个新资源。
Other Status Codes	ErrorResponse	意外的错误响应。

安全性

Ocp-Apim-Subscription-Key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: accessCode
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize
令牌 URL: https://login.microsoftonline.com/common/oauth2/token

作用域

名称	说明
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"
}

定义

名称	说明
CreateProjectOptions	表示用于创建或更新项目的选项。
Error	错误对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectKind
ProjectSettings	表示用于定义项目行为的设置。
TextAnalysisAuthoringProjectMetadata	表示项目的元数据。

CreateProjectOptions

表示用于创建或更新项目的选项。

名称	类型	说明
description	string	项目说明。
language	string	项目语言。这是语言的 BCP-47 表示形式。例如，将“en”用于英语，“en-gb”用于英语（英国），将“es”用于西班牙语等。
multilingual	boolean	项目是否用于多种语言。
projectKind	ProjectKind	项目类型。
projectName	string	新项目名称。
settings	ProjectSettings	项目设置。
storageInputContainerName	string	存储容器名称。

Error

错误对象。

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

ErrorCode

人工可读错误代码。

名称	类型	说明
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

错误响应。

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

InnerErrorCode

人工可读错误代码。

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

ProjectSettings

表示用于定义项目行为的设置。

名称	类型	说明
confidenceThreshold	number	置信度最高的类的阈值，预测将自动更改为“None”。阈值的值应介于 0 和 1 之间（含）。

TextAnalysisAuthoringProjectMetadata

表示项目的元数据。

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

通过