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

Text Analysis Authoring - List Projects

参考

服务:: Cognitive Services - Language

API 版本:: 2023-04-01

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

名称	在	必需	类型	说明
Endpoint	path	True	string	支持的认知服务终结点 (例如 https://.api.cognitiveservices.azure.com).
api-version	query	True	string	客户端 API 版本。
maxpagesize	query		integer int32	单个响应中要包含的最大资源数。
skip	query		integer int32	要返回的第一个资源的集合中的偏移量。
top	query		integer int32	要从集合返回的最大资源数。

响应

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

安全性

AADToken

这些是 Azure Active Directory OAuth2 流。与 Azure 基于角色的访问控制配对时，它可用于控制对Azure Maps REST API 的访问。 Azure 基于角色的访问控制用于指定对一个或多个Azure Maps资源帐户或子资源的访问权限。可以通过内置角色或由一个或多个权限组成的自定义角色授予任何用户、组或服务主体的访问权限，以Azure Maps REST API。

若要实现方案，建议查看身份验证概念。总之，此安全定义提供了一种解决方案，用于通过能够对特定 API 和作用域进行访问控制的对象对应用程序 () 建模。

备注

此安全定义需要使用x-ms-client-id 标头来指示应用程序请求访问的Azure Maps资源。这可以从地图管理 API 获取。

Authorization URL特定于 Azure 公有云实例。主权云具有唯一的授权 URL 和 Azure Active Directory 配置。 * Azure 基于角色的访问控制是通过 Azure 门户、PowerShell、CLI、Azure SDK 或 REST API 从 Azure 管理平面配置的。 * 使用 Azure Maps Web SDK 允许针对多个用例对应用程序进行基于配置的设置。

目前，Azure Active Directory v1.0 或 v2.0 支持工作、学校和来宾，但不支持个人帐户。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
https://cognitiveservices.azure.com/.default	https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

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

类型: apiKey
在: header

示例

Successful List Projects

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "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
}

定义

名称	说明
Error	错误对象。
ErrorCode	用户可读的错误代码。
ErrorResponse	错误响应。
InnerErrorCode	用户可读的错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectKind	项目类型。
TextAnalysisAuthoringProjectMetadata	表示项目的元数据。
TextAnalysisAuthoringProjectSettings	表示用于定义项目行为的设置。
TextAnalysisAuthoringProjectsMetadata	表示检索到的项目元数据的列表。

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 One 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。

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	TextAnalysisAuthoringProjectSettings	项目设置。
storageInputContainerName	string	存储容器名称。

TextAnalysisAuthoringProjectSettings

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

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

TextAnalysisAuthoringProjectsMetadata

表示检索到的项目元数据的列表。

名称	类型	说明
nextLink	string	下一页链接。
value	TextAnalysisAuthoringProjectMetadata[]	项目列表。

通过