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

Conversational Analysis Authoring - Import

服务:

Azure AI Services

API 版本:

2023-04-01

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

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

具有可选参数:

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

URI 参数

名称	在	必需	类型	说明
Endpoint	path	True	string
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: 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

示例

Successful Import Project

示例请求

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": []
      }
    ]
  }
}

示例响应

状态代码:

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一个 API 指南 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
OrchestrationTargetProjectKind
ProjectKind
StringIndexType

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	此陈述的数据集。 允许的值为“训练”和“测试”。
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	此陈述的数据集。 允许的值为“训练”和“测试”。
intent	string	陈述的意图。
language	string	表示言语的语言。 这是语言的 BCP-47 表示形式。 例如，将“en”用于英语，“en-gb”用于英语（英国），将“es”用于西班牙语等。
text	string	言语文本。

ConversationalAnalysisAuthoringProjectSettings

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

名称	类型	说明
confidenceThreshold	number	置信度最高的意向阈值，预测将自动更改为“None”。 阈值的值应介于 0 和 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一个 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	错误目标。

OrchestrationTargetProjectKind

名称	类型	说明
Conversation	string
Luis	string
QuestionAnswering	string

ProjectKind

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

StringIndexType

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