Conversational Analysis Authoring - Create Project

リファレンス

サービス:: Azure AI Services

API バージョン:: 2023-04-01

新しいプロジェクトを作成するか、既存のプロジェクトを更新します。

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

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string
projectName	path	True	string	新しいプロジェクト名。
api-version	query	True	string	この操作に使用する API バージョン。

要求本文

Media Types: "application/merge-patch+json"

名前	必須	型	説明
language	True	string	プロジェクト言語。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
projectKind	True	ProjectKind	プロジェクトの種類を表します。
projectName	True	string	新しいプロジェクト名。
description		string	プロジェクトの説明。
multilingual		boolean	プロジェクトを複数の言語に使用するかどうか。
settings		ConversationalAnalysisAuthoringProjectSettings	プロジェクトの設定。

応答

名前	型	説明
200 OK	ConversationalAnalysisAuthoringProjectMetadata	要求は成功しました。
201 Created	ConversationalAnalysisAuthoringProjectMetadata	要求が成功し、結果として新しいリソースが作成されました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

Ocp-Apim-Subscription-Key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize
Token URL (トークン URL): https://login.microsoftonline.com/common/oauth2/token

スコープ

名前	説明
https://cognitiveservices.azure.com/.default

例

Successful Create Project

要求のサンプル

HTTP

PATCH {Endpoint}/language/authoring/analyze-conversations/projects/myproject?api-version=2023-04-01

{
  "projectName": "myproject",
  "language": "en",
  "projectKind": "Conversation",
  "description": "This is a sample conversation project.",
  "multilingual": false
}

応答のサンプル

状態コード:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

状態コード:: 200

{
  "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": "Conversation",
  "projectName": "myproject",
  "multilingual": false,
  "description": "This is a sample conversation project.",
  "language": "en"
}

定義

名前	説明
ConversationalAnalysisAuthoringCreateProjectOptions	プロジェクトの作成または更新に使用するオプションを表します。
ConversationalAnalysisAuthoringProjectMetadata	プロジェクトのメタデータを表します。
ConversationalAnalysisAuthoringProjectSettings	プロジェクトの動作を定義するために使用する設定を表します。
Error	エラーオブジェクト。
ErrorCode	人間が判読できるエラーコード。
ErrorResponse	エラー応答。
InnerErrorCode	人間が判読できるエラーコード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectKind

ConversationalAnalysisAuthoringCreateProjectOptions

プロジェクトの作成または更新に使用するオプションを表します。

名前	型	説明
description	string	プロジェクトの説明。
language	string	プロジェクト言語。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
multilingual	boolean	プロジェクトを複数の言語に使用するかどうか。
projectKind	ProjectKind	プロジェクトの種類を表します。
projectName	string	新しいプロジェクト名。
settings	ConversationalAnalysisAuthoringProjectSettings	プロジェクトの設定。

ConversationalAnalysisAuthoringProjectMetadata

プロジェクトのメタデータを表します。

名前	型	説明
createdDateTime	string	プロジェクトの作成日時を表します。
description	string	プロジェクトの説明。
language	string	プロジェクト言語。これは、言語の BCP-47 表現です。たとえば、英語の場合は "en"、英語 (英国) の場合は "en-gb"、スペイン語の場合は "es" を使用します。
lastDeployedDateTime	string	プロジェクトの最後に配置された datetime を表します。
lastModifiedDateTime	string	プロジェクトの作成日時を表します。
lastTrainedDateTime	string	プロジェクトの最後のトレーニング日時を表します。
multilingual	boolean	プロジェクトを複数の言語に使用するかどうか。
projectKind	ProjectKind	プロジェクトの種類を表します。
projectName	string	新しいプロジェクト名。
settings	ConversationalAnalysisAuthoringProjectSettings	プロジェクトの設定。

ConversationalAnalysisAuthoringProjectSettings

プロジェクトの動作を定義するために使用する設定を表します。

名前	型	説明
confidenceThreshold	number	予測が自動的に "なし" に変更される、最も高い信頼度を持つ意図のしきい値。しきい値の値は、0 ~ 1 の範囲にする必要があります。

Error

エラーオブジェクト。

名前	型	説明
code	ErrorCode	サーバー定義の一連のエラーコードの 1 つ。
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