Text Analysis Authoring - Create Project

リファレンス

サービス:: Azure AI Services

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

リソースに適用される最も基本的な操作。

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

URI パラメーター

名前	/	必須	型	説明
Endpoint	path	True	string url	サポートされている Cognitive Services エンドポイント (例: https://.api.cognitiveservices.azure.com).
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	新しいプロジェクト名。
storageInputContainerName	True	string	ストレージコンテナー名。
description		string	プロジェクトの説明。
multilingual		boolean	プロジェクトを複数の言語に使用するかどうか。
settings		ProjectSettings	プロジェクトの設定。

応答

名前	型	説明
200 OK	TextAnalysisAuthoringProjectMetadata	要求は成功しました。
201 Created	TextAnalysisAuthoringProjectMetadata	要求が成功し、結果として新しいリソースが作成されました。
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-text/projects/LoanAgreements?api-version=2023-04-01

{
  "projectName": "LoanAgreements",
  "language": "en",
  "projectKind": "CustomEntityRecognition",
  "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.",
  "multilingual": false,
  "storageInputContainerName": "loanagreements"
}

応答のサンプル

状態コード:: 201

{
  "createdDateTime": "2022-04-18T13:53:03Z",
  "lastModifiedDateTime": "2022-04-18T13:53:03Z",
  "projectKind": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "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"
}

状態コード:: 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": "CustomEntityRecognition",
  "storageInputContainerName": "loanagreements",
  "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"
}

定義

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

CreateProjectOptions

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

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

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

人間が判読できるエラーコード。

名前	型	説明
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	サーバー定義の一連のエラーコードの 1 つ。
details	object	エラーの詳細。
innererror	InnerErrorModel	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ProjectKind

名前	型	説明
CustomEntityRecognition	string	独自のデータを使用してドメインカテゴリを識別する抽出モデルを構築する場合。
CustomMultiLabelClassification	string	独自のデータを使用してテキストを分類する分類モデルを構築する場合。各ファイルには、1 つまたは複数のラベルを含めることができます。たとえば、ファイル 1 は A、B、C に分類され、ファイル 2 は B と C に分類されます。
CustomSingleLabelClassification	string	独自のデータを使用してテキストを分類する分類モデルを構築する場合。各ファイルにはラベルが 1 つだけ含まれます。たとえば、ファイル 1 は A に分類され、ファイル 2 は B として分類されます。

ProjectSettings

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

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

TextAnalysisAuthoringProjectMetadata

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

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

次の方法で共有