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

Conversational Analysis Authoring - Import

Service:

Cognitive Services - Language

API Version:

2023-04-01

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

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

With optional parameters:

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2023-04-01

URI 参数

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

请求正文

名称	必需	类型	说明
metadata	True	ConversationalAnalysisAuthoringCreateProjectOptions	表示项目元数据。
projectFileVersion	True	string	导出的文件的版本。
stringIndexType	True	StringIndexType	指定用于解释字符串偏移量的方法。 有关其他信息，请参见 https://aka.ms/text-analytics-offsets。
assets		ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	表示项目资产。

响应

名称	类型	说明
202 Accepted		带有用于检查作业状态的 Operation-Location 标头的成功调用结果。 Headers operation-location: string
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 支持工作、学校和来宾，但不支持个人帐户。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Ocp-Apim-Subscription-Key

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

Type: apiKey
In: header

示例

Successful Import Project

Sample Request

HTTP

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

{
  "projectFileVersion": "2022-05-01",
  "stringIndexType": "Utf16CodeUnit",
  "metadata": {
    "projectKind": "Conversation",
    "settings": {
      "confidenceThreshold": 0.7
    },
    "projectName": "EmailApp",
    "multilingual": true,
    "description": "Trying out CLU",
    "language": "en-us"
  },
  "assets": {
    "projectKind": "Conversation",
    "intents": [
      {
        "category": "Read"
      },
      {
        "category": "Delete"
      }
    ],
    "entities": [
      {
        "category": "Sender"
      },
      {
        "category": "Number",
        "regex": {
          "expressions": [
            {
              "regexKey": "UK Phone numbers",
              "language": "en-us",
              "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/"
            }
          ]
        }
      }
    ],
    "utterances": [
      {
        "text": "Open Blake's email",
        "dataset": "Train",
        "intent": "Read",
        "entities": [
          {
            "category": "Sender",
            "offset": 5,
            "length": 5
          }
        ]
      },
      {
        "text": "Delete last email",
        "language": "en-gb",
        "dataset": "Test",
        "intent": "Delete",
        "entities": []
      }
    ]
  }
}

Sample Response

Status code:

202

operation-location: {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-04-01

定义

名称	说明
CompositionSetting	当实体的组件相互重叠时要遵循的行为。
ConversationalAnalysisAuthoringConversationExportedEntity	表示实体及其组件。
ConversationalAnalysisAuthoringConversationExportedIntent	表示对话项目的导出意向。
ConversationalAnalysisAuthoringConversationExportedProjectAssets	表示对话项目的导出资产。
ConversationalAnalysisAuthoringConversationExportedUtterance	表示对话项目的导出话语。
ConversationalAnalysisAuthoringCreateProjectOptions	表示用于创建或更新项目的选项。
ConversationalAnalysisAuthoringExportedConversationOrchestration	定义对话项目目标的业务流程详细信息。
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions	表示对话项目目标的业务流程选项。
ConversationalAnalysisAuthoringExportedEntityList	表示实体的列表组件。
ConversationalAnalysisAuthoringExportedEntityListSynonym	表示列表组件中的同义词列表
ConversationalAnalysisAuthoringExportedEntityRegex	表示实体的正则表达式组件。
ConversationalAnalysisAuthoringExportedEntityRegexExpression	表示正则表达式组件中的正则表达式。 此表达式遵循 .NET 正则表达式语法。 此处检查以供参考：https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions
ConversationalAnalysisAuthoringExportedEntitySublist	表示列表组件内的子列表。
ConversationalAnalysisAuthoringExportedLuisOrchestration	定义 LUIS 应用程序目标的业务流程详细信息。
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions	表示 LUIS 应用程序目标的业务流程选项。
ConversationalAnalysisAuthoringExportedPrebuiltEntity	表示导出的预生成实体组件
ConversationalAnalysisAuthoringExportedProject	表示导出的项目。
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	定义问题解答项目目标的业务流程详细信息。
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	表示问题解答项目目标的业务流程选项。
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel	表示话语的实体标签。
ConversationalAnalysisAuthoringOrchestrationExportedIntent	表示业务流程项目的导出意向。
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	表示业务流程项目的资产。
ConversationalAnalysisAuthoringOrchestrationExportedUtterance	表示业务流程项目的话语。
ConversationalAnalysisAuthoringProjectSettings	表示用于定义项目行为的设置。
Error	错误对象。
ErrorCode	人类可读的错误代码。
ErrorResponse	错误响应。
ExportedProjectFormat	要使用的导出项目文件的格式。
InnerErrorCode	人类可读的错误代码。
InnerErrorModel	包含有关错误的更具体信息的对象。 根据 Microsoft One API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectKind	表示项目类型。
StringIndexType	指定用于解释字符串偏移量的方法。 有关其他信息，请参见 https://aka.ms/text-analytics-offsets。

CompositionSetting

当实体的组件相互重叠时要遵循的行为。

名称	类型	说明
combineComponents	string	在文本中找到两个或更多个组件并重叠时，组件跨度将合并到一个范围，并合并所有组件。
requireExactOverlap	string	所有组件都必须在文本中完全相同的字符处重叠，以便实体返回。 如果定义的组件中有一个不匹配或预测不到，则实体将不会返回。
returnLongestOverlap	string	在文本中找到两个或更多个组件并重叠时，将返回具有最长字符集的组件。
separateComponents	string	每个组件的匹配或预测都作为实体的单独实例返回。

ConversationalAnalysisAuthoringConversationExportedEntity

表示实体及其组件。

名称	类型	说明
category	string	实体的类别。
compositionSetting	CompositionSetting	当实体的组件相互重叠时要遵循的行为。
list	ConversationalAnalysisAuthoringExportedEntityList	实体的列表组件。
prebuilts	ConversationalAnalysisAuthoringExportedPrebuiltEntity[]	预生成的实体组件。
regex	ConversationalAnalysisAuthoringExportedEntityRegex	实体的正则表达式组件。
requiredComponents	string[]	所需的组件。 允许的值为“learned”、“list”、“prebuilts”和“regex”。

ConversationalAnalysisAuthoringConversationExportedIntent

表示对话项目的导出意向。

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

ConversationalAnalysisAuthoringConversationExportedProjectAssets

表示对话项目的导出资产。

名称	类型	说明
entities	ConversationalAnalysisAuthoringConversationExportedEntity[]	项目中定义的实体。
intents	ConversationalAnalysisAuthoringConversationExportedIntent[]	项目中定义的意向。
projectKind	string: Conversation	包含资产的项目类型。
utterances	ConversationalAnalysisAuthoringConversationExportedUtterance[]	项目中定义的话语。

ConversationalAnalysisAuthoringConversationExportedUtterance

表示对话项目的导出话语。

名称	类型	说明
dataset	string	此话语的数据集。 允许的值为“Train”和“Test”。
entities	ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]	表示话语的实体标签。
intent	string	言语的意图。
language	string	表示话语的语言。 这是语言的 BCP-47 表示形式。 例如，将“en”用于英语，“en-gb”用于英语 (英国) ，“es”用于西班牙语等。
text	string	话语文本。

ConversationalAnalysisAuthoringCreateProjectOptions

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

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

ConversationalAnalysisAuthoringExportedConversationOrchestration

定义对话项目目标的业务流程详细信息。

名称	类型	说明
deploymentName	string	目标部署的名称。
projectName	string	目标项目的名称。

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

表示对话项目目标的业务流程选项。

名称	类型	说明
conversationOrchestration	ConversationalAnalysisAuthoringExportedConversationOrchestration	对话项目目标详细信息。
targetProjectKind	string: Conversation	业务流程中使用的目标的种类。

ConversationalAnalysisAuthoringExportedEntityList

表示实体的列表组件。

名称	类型	说明
sublists	ConversationalAnalysisAuthoringExportedEntitySublist[]	列表组件的子列表。

ConversationalAnalysisAuthoringExportedEntityListSynonym

表示列表组件中的同义词列表

名称	类型	说明
language	string	表示同义词的语言。 这是语言的 BCP-47 表示形式。 例如，将“en”用于英语，“en-gb”用于英语 (英国) ，“es”用于西班牙语等。
values	string[]	同义词列表。

ConversationalAnalysisAuthoringExportedEntityRegex

表示实体的正则表达式组件。

名称	类型	说明
expressions	ConversationalAnalysisAuthoringExportedEntityRegexExpression[]	正则表达式组件的正则表达式。 这些表达式遵循 .NET 正则表达式语法。 此处检查以供参考：https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

ConversationalAnalysisAuthoringExportedEntityRegexExpression

表示正则表达式组件中的正则表达式。 此表达式遵循 .NET 正则表达式语法。 此处检查以供参考：https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions

名称	类型	说明
language	string	表示正则表达式的语言。 这是语言的 BCP-47 表示形式。 例如，将“en”用于英语，“en-gb”用于英语 (英国) ，“es”用于西班牙语等。
regexKey	string	正则表达式的键。
regexPattern	string	正则表达式模式。

ConversationalAnalysisAuthoringExportedEntitySublist

表示列表组件内的子列表。

名称	类型	说明
listKey	string	子列表的键。
synonyms	ConversationalAnalysisAuthoringExportedEntityListSynonym[]	对应于子列表的 短语。

ConversationalAnalysisAuthoringExportedLuisOrchestration

定义 LUIS 应用程序目标的业务流程详细信息。

名称	类型	说明
appId	string	LUIS 应用程序 ID。
appVersion	string	目标版本 ID。
slotName	string	目标槽名称。

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

表示 LUIS 应用程序目标的业务流程选项。

名称	类型	说明
luisOrchestration	ConversationalAnalysisAuthoringExportedLuisOrchestration	LUIS 应用程序目标详细信息。
targetProjectKind	string: Luis	业务流程中使用的目标的种类。

ConversationalAnalysisAuthoringExportedPrebuiltEntity

表示导出的预生成实体组件

名称	类型	说明
category	string	预生成的实体类别。

ConversationalAnalysisAuthoringExportedProject

表示导出的项目。

名称	类型	说明
assets	ConversationalAnalysisAuthoringExportedProjectAssets: ConversationalAnalysisAuthoringConversationExportedProjectAssets ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets	表示项目资产。
metadata	ConversationalAnalysisAuthoringCreateProjectOptions	表示项目元数据。
projectFileVersion	string	导出的文件的版本。
stringIndexType	StringIndexType	指定用于解释字符串偏移量的方法。 有关其他信息，请参见 https://aka.ms/text-analytics-offsets。

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

定义问题解答项目目标的业务流程详细信息。

名称	类型	说明
projectName	string	目标项目的名称。

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

表示问题解答项目目标的业务流程选项。

名称	类型	说明
questionAnsweringOrchestration	ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration	问题解答项目详细信息。
targetProjectKind	string: QuestionAnswering	业务流程中使用的目标的种类。

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

表示话语的实体标签。

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

ConversationalAnalysisAuthoringOrchestrationExportedIntent

表示业务流程项目的导出意向。

名称	类型	说明
category	string	意向类别。
orchestration	ConversationalAnalysisAuthoringExportedOrchestrationOptions: ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions	指定此意向在业务流程流中的行为。

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

表示业务流程项目的资产。

名称	类型	说明
intents	ConversationalAnalysisAuthoringOrchestrationExportedIntent[]	表示项目的意向。
projectKind	string: Orchestration	包含资产的项目类型。
utterances	ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]	表示项目的话语。

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

表示业务流程项目的话语。

名称	类型	说明
dataset	string	此话语的数据集。 允许的值为“Train”和“Test”。
intent	string	言语的意图。
language	string	表示话语的语言。 这是语言的 BCP-47 表示形式。 例如，将“en”用于英语，“en-gb”用于英语 (英国) ，“es”用于西班牙语等。
text	string	话语文本。

ConversationalAnalysisAuthoringProjectSettings

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

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

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

ExportedProjectFormat

要使用的导出项目文件的格式。

名称	类型	说明
Conversation	string	指定对话项目的格式。
Luis	string	指定从 LUIS 导出的应用程序的格式。

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

表示项目类型。

名称	类型	说明
Conversation	string	用于在应用、机器人和 IoT 设备中构建自然语言的项目。
Orchestration	string	一个项目，用于在单个项目中连接和协调对话、自定义问答和 LUIS 项目。

StringIndexType

指定用于解释字符串偏移量的方法。 有关其他信息，请参见 https://aka.ms/text-analytics-offsets。

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