Text Analysis Authoring - Train

サービス:

Azure AI Services

API バージョン:

2023-04-01

プロジェクトのトレーニング ジョブをトリガーします。

POST {Endpoint}/language/authoring/analyze-text/projects/{projectName}/:train?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 バージョン。

要求本文

名前	必須	型	説明
modelLabel	True	string	出力モデル ラベルを表します。
trainingConfigVersion	True	string	トレーニング構成バージョンを表します。
evaluationOptions		TextAnalysisAuthoringEvaluationOptions	評価オプションを表します。 既定では、評価の種類はパーセンテージで、トレーニング分割の割合は 80、テストの分割率は 20 です。

応答

名前	型	説明
202 Accepted		要求は処理のために受け入れ済みですが、処理はまだ完了していません。 ヘッダー Operation-Location: string
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

例

SuccessfulTrainProject

要求のサンプル

HTTP

POST {Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/:train?api-version=2023-04-01

{
  "modelLabel": "model1",
  "trainingConfigVersion": "latest",
  "evaluationOptions": {
    "kind": "percentage",
    "testingSplitPercentage": 20,
    "trainingSplitPercentage": 80
  }
}

応答のサンプル

状態コード:

202

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

定義

名前	説明
Error	エラー オブジェクト。
ErrorCode	人間が判読できるエラー コード。
ErrorResponse	エラー応答。
EvaluationKind
InnerErrorCode	人間が判読できるエラー コード。
InnerErrorModel	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
TextAnalysisAuthoringEvaluationOptions	評価の実行に使用されるオプションを表します。
TextAnalysisAuthoringTrainingJobOptions	新しいトレーニング ジョブを開始するためのオプションを表します。

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	エラー オブジェクト。

EvaluationKind

名前	型	説明
manual	string	データ内のすべての例について、選択したデータセットに従ってデータを分割します。
percentage	string	ユーザー定義のパーセンテージに従って、データをトレーニング セットとテスト セットに分割します。

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	エラーターゲット。

TextAnalysisAuthoringEvaluationOptions

評価の実行に使用されるオプションを表します。

名前	型	説明
kind	EvaluationKind	評価の種類を表します。 既定では、評価の種類はパーセンテージに設定されます。
testingSplitPercentage	integer	テスト データセットの分割率を表します。 評価の種類がパーセンテージの場合にのみ必要です。
trainingSplitPercentage	integer	トレーニング データセットの分割率を表します。 評価の種類がパーセンテージの場合にのみ必要です。

TextAnalysisAuthoringTrainingJobOptions

新しいトレーニング ジョブを開始するためのオプションを表します。

名前	型	説明
evaluationOptions	TextAnalysisAuthoringEvaluationOptions	評価オプションを表します。 既定では、評価の種類はパーセンテージで、トレーニング分割の割合は 80、テストの分割率は 20 です。
modelLabel	string	出力モデル ラベルを表します。
trainingConfigVersion	string	トレーニング構成バージョンを表します。