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

Text Analysis Authoring - Import

参考

服务:: Azure AI Services

API 版本:: 2023-04-01

触发作业以导入项目。如果已存在同名的项目，则会替换该项目的数据。

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:import?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 版本。

请求正文

名称	必需	类型	说明
metadata	True	CreateProjectOptions	表示项目元数据。
projectFileVersion	True	string	导出的文件的版本。
stringIndexType	True	StringIndexType	指定用于解释字符串偏移的方法。有关详细信息，请参阅 https://aka.ms/text-analytics-offsets。
assets		ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	表示项目资产。

响应

名称	类型	说明
202 Accepted		已接受请求进行处理，但尚未完成处理。标头 Operation-Location: string
Other Status Codes	ErrorResponse	意外的错误响应。

名称

类型

说明

202 Accepted

已接受请求进行处理，但尚未完成处理。

标头

Operation-Location: string

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

示例

SuccessfulImportProject

示例请求

HTTP

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:import?api-version=2023-04-01

{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "CustomEntityRecognition",
    "storageInputContainerName": "loanagreements",
    "settings": {},
    "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"
  },
  "assets": {
    "projectKind": "CustomEntityRecognition",
    "entities": [
      {
        "category": "Date"
      },
      {
        "category": "LenderName"
      },
      {
        "category": "LenderAddress"
      }
    ],
    "documents": [
      {
        "location": "01.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1793,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 9
              },
              {
                "category": "LenderName",
                "offset": 273,
                "length": 14
              },
              {
                "category": "LenderAddress",
                "offset": 314,
                "length": 15
              }
            ]
          }
        ]
      },
      {
        "location": "02.txt",
        "language": "en-us",
        "entities": [
          {
            "regionOffset": 0,
            "regionLength": 1804,
            "labels": [
              {
                "category": "Date",
                "offset": 5,
                "length": 10
              },
              {
                "category": "LenderName",
                "offset": 284,
                "length": 10
              },
              {
                "category": "LenderAddress",
                "offset": 321,
                "length": 20
              }
            ]
          }
        ]
      }
    ]
  }
}

示例响应

状态代码:: 202

operation-location: {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01

定义

名称	说明
CreateProjectOptions	表示用于创建或更新项目的选项。
Error	错误对象。
ErrorCode	人工可读错误代码。
ErrorResponse	错误响应。
ExportedProject	表示导出的项目。
InnerErrorCode	人工可读错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。根据Microsoft一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectKind
ProjectSettings	表示用于定义项目行为的设置。
StringIndexType
TextAnalysisAuthoringExportedClass	表示导出项目的类。
TextAnalysisAuthoringExportedCustomEntityRecognitionDocument	表示自定义实体识别项目的导出文档。
TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets	表示实体识别项目的导出资产。
TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument	表示自定义多标签分类项目的导出文档。
TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets	表示自定义多标签分类项目的导出资产。
TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument	表示自定义单标签分类项目的导出文档。
TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	表示单标签分类项目的导出资产。
TextAnalysisAuthoringExportedDocumentClass	表示文档的分类标签。
TextAnalysisAuthoringExportedDocumentEntityLabel	表示文档的实体标签。
TextAnalysisAuthoringExportedDocumentEntityRegion	表示文档中用于实体标记的区域。
TextAnalysisAuthoringExportedEntity	表示导出项目中的实体。

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	错误对象。

ExportedProject

表示导出的项目。

名称	类型	说明
assets	ExportedProjectAssets: TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets	表示项目资产。
metadata	CreateProjectOptions	表示项目元数据。
projectFileVersion	string	导出的文件的版本。
stringIndexType	StringIndexType	指定用于解释字符串偏移的方法。有关详细信息，请参阅 https://aka.ms/text-analytics-offsets。

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 之间（含）。

StringIndexType

名称	类型	说明
Utf16CodeUnit	string	偏移量和长度值将对应于 UTF-16 代码单元。如果应用程序是用支持 Unicode 的语言（例如 Java、JavaScript）编写的，请使用此选项。

TextAnalysisAuthoringExportedClass

表示导出项目的类。

名称	类型	说明
category	string	类类别。

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

表示自定义实体识别项目的导出文档。

名称	类型	说明
dataset	string	本文档的数据集。允许的值为“训练”和“测试”。
entities	TextAnalysisAuthoringExportedDocumentEntityRegion[]	属于文档的实体标签列表。
language	string	表示文档语言。这是语言的 BCP-47 表示形式。例如，将“en”用于英语，“en-gb”用于英语（英国），将“es”用于西班牙语等。
location	string	存储中文档的位置。

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

表示实体识别项目的导出资产。

名称	类型	说明
documents	TextAnalysisAuthoringExportedCustomEntityRecognitionDocument[]	属于项目的文档列表。
entities	TextAnalysisAuthoringExportedEntity[]	属于项目的实体列表。
projectKind	string: CustomEntityRecognition

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

表示自定义多标签分类项目的导出文档。

名称	类型	说明
classes	TextAnalysisAuthoringExportedDocumentClass[]	文档类。
dataset	string	本文档的数据集。允许的值为“训练”和“测试”。
language	string	表示文档语言。这是语言的 BCP-47 表示形式。例如，将“en”用于英语，“en-gb”用于英语（英国），将“es”用于西班牙语等。
location	string	存储中文档的位置。

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

表示自定义多标签分类项目的导出资产。

名称	类型	说明
classes	TextAnalysisAuthoringExportedClass[]	项目中的类列表。
documents	TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument[]	项目中的文档列表。
projectKind	string: CustomMultiLabelClassification

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

表示自定义单标签分类项目的导出文档。

名称	类型	说明
class	TextAnalysisAuthoringExportedDocumentClass	文档的类。
dataset	string	本文档的数据集。允许的值为“训练”和“测试”。
language	string	表示文档语言。这是语言的 BCP-47 表示形式。例如，将“en”用于英语，“en-gb”用于英语（英国），将“es”用于西班牙语等。
location	string	存储中文档的位置。

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

表示单标签分类项目的导出资产。

名称	类型	说明
classes	TextAnalysisAuthoringExportedClass[]	属于此项目的类的列表。
documents	TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument[]	属于此项目的文档列表。
projectKind	string: CustomSingleLabelClassification

TextAnalysisAuthoringExportedDocumentClass

表示文档的分类标签。

名称	类型	说明
category	string

TextAnalysisAuthoringExportedDocumentEntityLabel

表示文档的实体标签。

名称	类型	说明
category	string	实体类别。
length	integer	实体文本的长度。
offset	integer	实体文本的起始位置。

TextAnalysisAuthoringExportedDocumentEntityRegion

表示文档中用于实体标记的区域。

名称	类型	说明
labels	TextAnalysisAuthoringExportedDocumentEntityLabel[]	属于此区域的实体标签列表。
regionLength	integer	区域文本的长度。
regionOffset	integer	区域的起始位置。

TextAnalysisAuthoringExportedEntity

表示导出项目中的实体。

名称	类型	说明
category	string	实体类别。

通过

Text Analysis Authoring - Import

URI 参数

请求正文

响应

安全性

Ocp-Apim-Subscription-Key

OAuth2Auth

作用域

示例

SuccessfulImportProject

示例请求

示例响应

定义

CreateProjectOptions

Error

ErrorCode

ErrorResponse

ExportedProject

InnerErrorCode

InnerErrorModel

ProjectKind

ProjectSettings

StringIndexType

TextAnalysisAuthoringExportedClass

TextAnalysisAuthoringExportedCustomEntityRecognitionDocument

TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets

TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument

TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets

TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument

TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets

TextAnalysisAuthoringExportedDocumentClass

TextAnalysisAuthoringExportedDocumentEntityLabel

TextAnalysisAuthoringExportedDocumentEntityRegion

TextAnalysisAuthoringExportedEntity

其他资源