共用方式為

Conversational Analysis Authoring - Import

  • 參考
服務:
Azure AI Services
API 版本:
2022-05-01

觸發作業以匯入專案。 如果具有相同名稱的項目已經存在，則會取代該專案的數據。

POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?api-version=2022-05-01
含選擇性參數: 
POST {Endpoint}/language/authoring/analyze-conversations/projects/{projectName}/:import?format={format}&api-version=2022-05-01

URI 參數

名稱 位於 必要 類型 Description
Endpoint
 path True

string

支援的認知服務端點 （例如，https://.api.cognitiveservices.azure.com).
projectName
 path True

string

maxLength: 100

要使用的項目名稱。
api-version
 query True

string

用戶端 API 版本。
format
 query

ExportedProjectFormat

要使用的匯出項目檔格式。

要求標頭

名稱 必要 類型 Description
Ocp-Apim-Subscription-Key True

string

語言服務資源的訂用帳戶金鑰。

要求本文

名稱 必要 類型 Description
metadata True

ConversationalAnalysisAuthoringCreateProjectOptions

表示專案元數據。
projectFileVersion True

string

導出的檔案版本。
stringIndexType True

StringIndexType

指定用來解譯字串位移的方法。 如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。
assets ConversationalAnalysisAuthoringExportedProjectAssets:

表示項目資產。

回應

名稱 類型 Description
202 Accepted

成功的呼叫結果，其中包含用來檢查作業狀態的 Operation-Location 標頭。

標題

operation-location: string
Other Status Codes

ErrorResponse

錯誤回應。

安全性

Ocp-Apim-Subscription-Key

語言服務資源的訂用帳戶金鑰。

類型: apiKey
位於: header

範例

Successful Import Project

範例要求

POST {Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/:import?api-version=2022-05-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"
      }
    ],
    "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=2022-05-01

定義

名稱 Description
CompositionSetting

當實體的元件彼此重疊時，要遵循的行為。
ConversationalAnalysisAuthoringConversationExportedEntity

表示具有其元件的實體。
ConversationalAnalysisAuthoringConversationExportedIntent

表示交談項目導出的意圖。
ConversationalAnalysisAuthoringConversationExportedProjectAssets

表示交談項目導出的資產。
ConversationalAnalysisAuthoringConversationExportedUtterance

表示交談項目導出的語句。
ConversationalAnalysisAuthoringCreateProjectOptions

表示用來建立或更新項目的選項。
ConversationalAnalysisAuthoringExportedConversationOrchestration

定義對話專案目標的協調流程詳細數據。
ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

代表對話項目目標的協調流程選項。
ConversationalAnalysisAuthoringExportedEntityList

表示實體的清單元件。
ConversationalAnalysisAuthoringExportedEntityListSynonym

代表清單元件內的同義字清單
ConversationalAnalysisAuthoringExportedEntitySublist

表示清單元件內的子清單。
ConversationalAnalysisAuthoringExportedLuisOrchestration

定義 LUIS 應用程式目標的協調流程詳細數據。
ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

表示 LUIS 應用程式目標的協調流程選項。
ConversationalAnalysisAuthoringExportedPrebuiltEntity

表示導出的預先建置實體元件
ConversationalAnalysisAuthoringExportedProject

表示導出的專案。
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

定義問題解答專案目標的協調流程詳細數據。
ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

代表問題解答項目目標的協調流程選項。
ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

表示語句的實體標籤。
ConversationalAnalysisAuthoringOrchestrationExportedIntent

表示協調流程項目的導出意圖。
ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

表示協調流程項目的資產。
ConversationalAnalysisAuthoringOrchestrationExportedUtterance

表示協調流程項目的語句。
ConversationalAnalysisAuthoringProjectSettings

表示用來定義項目行為的設定。
Error

error 物件。
ErrorCode

人類可讀取的錯誤碼。
ErrorResponse

錯誤回應。
ExportedProjectFormat

要使用的匯出項目檔格式。
InnerErrorCode

人類可讀取的錯誤碼。
InnerErrorModel

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。
ProjectKind

表示項目種類。
StringIndexType

指定用來解譯字串位移的方法。 如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。

CompositionSetting

列舉型別

當實體的元件彼此重疊時，要遵循的行為。

值 Description
combineComponents

在文字中找到兩個或多個元件並重疊時，元件範圍會合併成一個範圍，以合併所有元件。
requireExactOverlap

所有元件都必須重疊在文字中完全相同的字元，實體才能傳回。 如果其中一個定義的元件不符合或預測，實體將不會傳回。
returnLongestOverlap

在文字中找到兩個或多個元件並重疊時，會傳回具有最長字元集的元件。
separateComponents

每個元件的比對或預測都會以實體的個別實例傳回。

ConversationalAnalysisAuthoringConversationExportedEntity

Object

表示具有其元件的實體。

名稱 類型 Description
category

string

實體的類別。
compositionSetting

CompositionSetting

當實體的元件彼此重疊時，要遵循的行為。
list

ConversationalAnalysisAuthoringExportedEntityList

實體的清單元件。
prebuilts

ConversationalAnalysisAuthoringExportedPrebuiltEntity[]

預先建置的實體元件。

ConversationalAnalysisAuthoringConversationExportedIntent

Object

表示交談項目導出的意圖。

名稱 類型 Description
category

string

意圖類別目錄。

ConversationalAnalysisAuthoringConversationExportedProjectAssets

Object

表示交談項目導出的資產。

名稱 類型 Description
entities

ConversationalAnalysisAuthoringConversationExportedEntity[]

項目中定義的實體。
intents

ConversationalAnalysisAuthoringConversationExportedIntent[]

項目中定義的意圖。
projectKind string:

Conversation

包含資產的項目類型。
utterances

ConversationalAnalysisAuthoringConversationExportedUtterance[]

項目中定義的語句。

ConversationalAnalysisAuthoringConversationExportedUtterance

Object

表示交談項目導出的語句。

名稱 類型 Description
dataset

string

這個語句的數據集。 允許的值為 『Train』 和 'Test'。
entities

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel[]

表示語句的實體標籤。
intent

string

語句的意圖。
language

string

表示語句的語言。 這是語言的 BCP-47 表示法。 例如，使用 「en」 代表英文、“en-gb” 代表英文 （UK）、“es” 代表西班牙文等。
text

string

語句文字。

ConversationalAnalysisAuthoringCreateProjectOptions

Object

表示用來建立或更新項目的選項。

名稱 類型 Description
description

string

專案描述。
language

string

項目語言。 這是語言的 BCP-47 表示法。 例如，使用 「en」 代表英文、“en-gb” 代表英文 （UK）、“es” 代表西班牙文等。
multilingual

boolean

專案是否要用於多種語言。
projectKind

ProjectKind

表示項目種類。
projectName

string

新的項目名稱。
settings

ConversationalAnalysisAuthoringProjectSettings

項目設定。

ConversationalAnalysisAuthoringExportedConversationOrchestration

Object

定義對話專案目標的協調流程詳細數據。

名稱 類型 Description
deploymentName

string

目標部署的名稱。
projectName

string

目標項目的名稱。

ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions

Object

代表對話項目目標的協調流程選項。

名稱 類型 Description
conversationOrchestration

ConversationalAnalysisAuthoringExportedConversationOrchestration

Conversational 項目目標詳細數據。
targetProjectKind string:

Conversation

協調流程中使用的目標種類。

ConversationalAnalysisAuthoringExportedEntityList

Object

表示實體的清單元件。

名稱 類型 Description
sublists

ConversationalAnalysisAuthoringExportedEntitySublist[]

清單元件的子清單。

ConversationalAnalysisAuthoringExportedEntityListSynonym

Object

代表清單元件內的同義字清單

名稱 類型 Description
language

string

表示同義字的語言。 這是語言的 BCP-47 表示法。 例如，使用 「en」 代表英文、“en-gb” 代表英文 （UK）、“es” 代表西班牙文等。
values

string[]

同義字清單。

ConversationalAnalysisAuthoringExportedEntitySublist

Object

表示清單元件內的子清單。

名稱 類型 Description
listKey

string

子清單的索引鍵。
synonyms

ConversationalAnalysisAuthoringExportedEntityListSynonym[]

對應至子清單的片語。

ConversationalAnalysisAuthoringExportedLuisOrchestration

Object

定義 LUIS 應用程式目標的協調流程詳細數據。

名稱 類型 Description
appId

string (uuid)

LUIS 應用程式識別碼。
appVersion

string

目標版本識別碼。
slotName

string

目標位置名稱。

ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions

Object

表示 LUIS 應用程式目標的協調流程選項。

名稱 類型 Description
luisOrchestration

ConversationalAnalysisAuthoringExportedLuisOrchestration

LUIS 應用程式目標詳細數據。
targetProjectKind string:

Luis

協調流程中使用的目標種類。

ConversationalAnalysisAuthoringExportedPrebuiltEntity

Object

表示導出的預先建置實體元件

名稱 類型 Description
category

string

預先建置的實體類別目錄。

ConversationalAnalysisAuthoringExportedProject

Object

表示導出的專案。

名稱 類型 Description
assets ConversationalAnalysisAuthoringExportedProjectAssets:

表示項目資產。
metadata

ConversationalAnalysisAuthoringCreateProjectOptions

表示專案元數據。
projectFileVersion

string

導出的檔案版本。
stringIndexType

StringIndexType

指定用來解譯字串位移的方法。 如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

Object

定義問題解答專案目標的協調流程詳細數據。

名稱 類型 Description
projectName

string

目標項目的名稱。

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions

Object

代表問題解答項目目標的協調流程選項。

名稱 類型 Description
questionAnsweringOrchestration

ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration

問題解答專案詳細數據。
targetProjectKind string:

QuestionAnswering

協調流程中使用的目標種類。

ConversationalAnalysisAuthoringExportedUtteranceEntityLabel

Object

表示語句的實體標籤。

名稱 類型 Description
category

string

實體標籤的類別。
length

integer (int32)

實體文字的長度。
offset

integer (int32)

實體文字的開始位置。

ConversationalAnalysisAuthoringOrchestrationExportedIntent

Object

表示協調流程項目的導出意圖。

名稱 類型 Description
category

string

意圖類別目錄。
orchestration ConversationalAnalysisAuthoringExportedOrchestrationOptions:

指定協調流程中這個意圖的行為。

ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets

Object

表示協調流程項目的資產。

名稱 類型 Description
intents

ConversationalAnalysisAuthoringOrchestrationExportedIntent[]

表示專案的意圖。
projectKind string:

Orchestration

包含資產的項目類型。
utterances

ConversationalAnalysisAuthoringOrchestrationExportedUtterance[]

表示項目的語句。

ConversationalAnalysisAuthoringOrchestrationExportedUtterance

Object

表示協調流程項目的語句。

名稱 類型 Description
dataset

string

這個語句的數據集。 允許的值為 『Train』 和 'Test'。
intent

string

語句的意圖。
language

string

表示語句的語言。 這是語言的 BCP-47 表示法。 例如，使用 「en」 代表英文、“en-gb” 代表英文 （UK）、“es” 代表西班牙文等。
text

string

語句文字。

ConversationalAnalysisAuthoringProjectSettings

Object

表示用來定義項目行為的設定。

名稱 類型 Description
confidenceThreshold

number (float)

具有最高信賴度的意圖閾值，預測會自動變更為 「無」。

Error

Object

error 物件。

名稱 類型 Description
code

ErrorCode

其中一組伺服器定義的錯誤碼。
details

Error[]

導致此錯誤之特定錯誤的詳細數據陣列。
innererror

InnerErrorModel

物件，包含與目前對象有關錯誤更具體的資訊。
message

string

錯誤的人類可讀取表示法。
target

string

錯誤的目標。

ErrorCode

列舉型別

人類可讀取的錯誤碼。

值 Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Conflict
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
QuotaExceeded
ServiceUnavailable
Timeout
TooManyRequests
Unauthorized
Warning

ErrorResponse

Object

錯誤回應。

名稱 類型 Description
error

Error

error 物件。

ExportedProjectFormat

列舉型別

要使用的匯出項目檔格式。

值 Description
Conversation

指定交談專案的格式。
Luis

指定從 LUIS 匯出之應用程式的格式。

InnerErrorCode

列舉型別

人類可讀取的錯誤碼。

值 Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
EmptyRequest
ExtractionFailure
InvalidCountryHint
InvalidDocument
InvalidDocumentBatch
InvalidParameterValue
InvalidRequest
InvalidRequestBodyFormat
KnowledgeBaseNotFound
MissingInputDocuments
ModelVersionIncorrect
UnsupportedLanguageCode

InnerErrorModel

Object

物件，包含有關錯誤的更特定資訊。 根據Microsoft一個 API 指導方針 - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses。

名稱 類型 Description
code

InnerErrorCode

其中一組伺服器定義的錯誤碼。
details

object

錯誤詳細數據。
innererror

InnerErrorModel

物件，包含與目前對象有關錯誤更具體的資訊。
message

string

錯誤資訊。
target

string

錯誤目標。

ProjectKind

列舉型別

表示項目種類。

值 Description
Conversation

將自然語言建置至應用程式、Bot 和IoT裝置的專案。
Orchestration

在單一專案中，連接及協調對話、自定義問題解答和 LUIS 專案的專案。

StringIndexType

列舉型別

指定用來解譯字串位移的方法。 如需詳細資訊，請參閱 https://aka.ms/text-analytics-offsets。

值 Description
Utf16CodeUnit

位移和長度值會對應至UTF-16程式代碼單位。 如果您的應用程式是以支援 Unicode 的語言撰寫，例如 Java、JavaScript，請使用此選項。