Evaluations - Create

サービス:: Azure AI Services

API バージョン:: v3.2-preview.2

新しい評価を作成します。

POST {endpoint}/speechtotext/v3.2-preview.2/evaluations

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://westus.api.cognitive.microsoft.com)。

要求本文

名前	必須	型	説明
dataset	True	EntityReference	EntityReference
displayName	True	string minLength: 1	オブジェクトの表示名。
locale	True	string minLength: 1	格納されているデータのロケール。
model1	True	EntityReference	EntityReference
model2	True	EntityReference	EntityReference
customProperties		object	このエンティティのカスタムプロパティ。許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。
description		string	オブジェクトの説明。
project		EntityReference	EntityReference
transcription1		EntityReference	EntityReference
transcription2		EntityReference	EntityReference

応答

名前	型	説明
201 Created	Evaluation	応答には、ペイロードとしてのエンティティとその場所に関する情報がヘッダーとして含まれます。ヘッダー Location: string
Other Status Codes	Error	エラーが発生しました。

名前

型

説明

201 Created

Evaluation

応答には、ペイロードとしてのエンティティとその場所に関する情報がヘッダーとして含まれます。

ヘッダー

Location: string

Other Status Codes

Error

エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

コグニティブサービスアカウントキーをここで指定します。

型: apiKey
/: header

Authorization

このリージョンの STS によって返される JWT からアクセストークンを指定します。 STS URL に次のクエリ文字列を追加して、トークンに管理スコープを追加してください: ?scope=speechservicesmanagement

型: apiKey
/: header

例

Create a evaluation

要求のサンプル

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/evaluations

{
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
  },
  "locale": "en-US",
  "displayName": "My new evaluation",
  "description": "The description of the evaluation"
}

応答のサンプル

状態コード:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6",
  "model1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "model2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "dataset": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
  },
  "transcription2": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
  },
  "transcription1": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/evaluations/00000000-0000-0000-0000-000000000000/files"
  },
  "properties": {
    "wordErrorRate2": 0.065,
    "wordErrorRate1": 0.065,
    "sentenceErrorRate2": 0.375,
    "sentenceCount2": 8,
    "wordCount2": 46,
    "correctWordCount2": 43,
    "wordSubstitutionCount2": 3,
    "wordDeletionCount2": 0,
    "wordInsertionCount2": 0,
    "sentenceErrorRate1": 0.375,
    "sentenceCount1": 8,
    "wordCount1": 46,
    "correctWordCount1": 43,
    "wordSubstitutionCount1": 3,
    "wordDeletionCount1": 0,
    "wordInsertionCount1": 0,
    "tokenErrorRate2": 0.125,
    "tokenErrorRate1": 0.125,
    "tokenCount2": 48,
    "correctTokenCount2": 42,
    "tokenSubstitutionCount2": 6,
    "tokenDeletionCount2": 0,
    "tokenInsertionCount2": 0,
    "tokenCount1": 48,
    "correctTokenCount1": 42,
    "tokenSubstitutionCount1": 6,
    "tokenDeletionCount1": 0,
    "tokenInsertionCount1": 0
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Evalution of one model against another model"
}

定義

名前	説明
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	エラー
ErrorCode	エラーコード
Evaluation	評価
EvaluationLinks	EvaluationLinks
EvaluationProperties	EvaluationProperties
InnerError	InnerError
Status	ステータス

DetailedErrorCode

列挙

DetailedErrorCode

値	説明
InvalidParameterValue	パラメーター値が無効です。
InvalidRequestBodyFormat	要求本文の形式が無効です。
EmptyRequest	空の要求。
MissingInputRecords	入力レコードがありません。
InvalidDocument	ドキュメントが無効です。
ModelVersionIncorrect	モデルのバージョンが正しくありません。
InvalidDocumentBatch	ドキュメントバッチが無効です。
UnsupportedLanguageCode	サポートされていない言語コード。
DataImportFailed	データのインポートに失敗しました。
InUseViolation	使用中の違反。
InvalidLocale	ロケールが無効です。
InvalidBaseModel	ベースモデルが無効です。
InvalidAdaptationMapping	適応マッピングが無効です。
InvalidDataset	データセットが無効です。
InvalidTest	テストが無効です。
FailedDataset	失敗したデータセット。
InvalidModel	モデルが無効です。
InvalidTranscription	文字起こしが無効です。
InvalidPayload	ペイロードが無効です。
InvalidParameter	パラメーターが無効です。
EndpointWithoutLogging	ログ記録なしのエンドポイント。
InvalidPermissions	アクセス許可が無効です。
InvalidPrerequisite	前提条件が無効です。
InvalidProductId	製品 ID が無効です。
InvalidSubscription	サブスクリプションが無効です。
InvalidProject	プロジェクトが無効です。
InvalidProjectKind	プロジェクトの種類が無効です。
InvalidRecordingsUri	無効な記録 URI。
OnlyOneOfUrlsOrContainerOrDataset	URL またはコンテナーまたはデータセットのいずれか 1 つだけ。
ExceededNumberOfRecordingsUris	記録 URI の数を超えました。
ModelMismatch	モデルの不一致。
ProjectGenderMismatch	プロジェクトの性別の不一致。
ModelDeprecated	モデルは非推奨になりました。
ModelExists	モデルが存在します。
ModelNotDeployable	モデルはデプロイできません。
EndpointNotUpdatable	エンドポイントは更新できません。
SingleDefaultEndpoint	単一の既定のエンドポイント。
EndpointCannotBeDefault	エンドポイントを既定にすることはできません。
InvalidModelUri	モデル URI が無効です。
SubscriptionNotFound	サブスクリプションが見つかりません。
QuotaViolation	クォータ違反。
UnsupportedDelta	サポートされていないデルタ。
UnsupportedFilter	サポートされていないフィルター。
UnsupportedPagination	サポートされていない改ページ位置。
UnsupportedDynamicConfiguration	サポートされていない動的構成。
UnsupportedOrderBy	サポートされていない注文者。
NoUtf8WithBom	bom を含む utf8 はありません。
ModelDeploymentNotCompleteState	モデルのデプロイが完了していない状態です。
SkuLimitsExist	SKU の制限が存在します。
DeployingFailedModel	失敗したモデルのデプロイ。
UnsupportedTimeRange	サポートされていない時間範囲。
InvalidLogDate	ログの日付が無効です。
InvalidLogId	無効なログ ID です。
InvalidLogStartTime	ログの開始時刻が無効です。
InvalidLogEndTime	ログの終了時刻が無効です。
InvalidTopForLogs	ログの top が無効です。
InvalidSkipTokenForLogs	ログのスキップトークンが無効です。
DeleteNotAllowed	削除は許可されていません。
Forbidden	禁じられた。
DeployNotAllowed	デプロイは許可されていません。
UnexpectedError	予期しないエラー。
InvalidCollection	コレクションが無効です。
InvalidCallbackUri	コールバック URI が無効です。
InvalidSasValidityDuration	SAS の有効期間が無効です。
InaccessibleCustomerStorage	お客様のストレージにアクセスできません。
UnsupportedClassBasedAdaptation	サポートされていないクラスベースの適応。
InvalidWebHookEventKind	Web フックイベントの種類が無効です。
InvalidTimeToLive	有効期限が無効です。
InvalidSourceAzureResourceId	ソース Azure リソース ID が無効です。
ModelCopyOperationExists	モデルのコピー操作が存在します。

EntityError

Object

EntityError

名前	型	説明
code	string	このエラーのコード。
message	string	このエラーのメッセージ。

EntityReference

Object

EntityReference

名前	型	説明
self	string (uri)	参照先エンティティの場所。

Error

Object

エラー

名前	型	説明
code	ErrorCode	エラーコード大まかなエラーコード。
details	Error[]	エラーや予想されるポリシーに関するその他のサポートの詳細。
innerError	InnerError	InnerError https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owで利用可能な Cognitive Services API ガイドラインに準拠した新しい内部エラー形式。これには、必須プロパティ ErrorCode、メッセージ、および省略可能なプロパティターゲット、details(キー値ペア)、内部エラー (入れ子にできます) が含まれます。
message	string	高レベルのエラーメッセージ。
target	string	エラーの原因。たとえば、無効なドキュメントの場合は "documents" または "document id" になります。

ErrorCode

列挙

エラーコード

値	説明
InvalidRequest	無効な要求エラーコードを表します。
InvalidArgument	無効な引数のエラーコードを表します。
InternalServerError	内部サーバーエラーコードを表します。
ServiceUnavailable	サービスを使用できないエラーコードを表します。
NotFound	見つからないエラーコードを表します。
PipelineError	パイプラインエラーコードを表します。
Conflict	競合エラーコードを表します。
InternalCommunicationFailed	内部通信に失敗したエラーコードを表します。
Forbidden	禁止されているエラーコードを表します。
NotAllowed	許可されていないエラーコードを表します。
Unauthorized	承認されていないエラーコードを表します。
UnsupportedMediaType	サポートされていないメディアの種類のエラーコードを表します。
TooManyRequests	要求の数が多すぎるエラーコードを表します。
UnprocessableEntity	処理不可能なエンティティエラーコードを表します。

Evaluation

Object

評価

名前	型	説明
createdDateTime	string (date-time)	オブジェクトが作成されたときのタイムスタンプ。タイムスタンプは ISO 8601 の日付と時刻の形式 ("YYYY-MM-DDThh:mm:ssZ"、 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations参照) としてエンコードされます。
customProperties	object	このエンティティのカスタムプロパティ。許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。
dataset	EntityReference	EntityReference
description	string	オブジェクトの説明。
displayName	string minLength: 1	オブジェクトの表示名。
lastActionDateTime	string (date-time)	現在の状態が入力されたときのタイムスタンプ。タイムスタンプは ISO 8601 の日付と時刻の形式 ("YYYY-MM-DDThh:mm:ssZ"、 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations参照) としてエンコードされます。
links	EvaluationLinks	EvaluationLinks
locale	string minLength: 1	格納されているデータのロケール。
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EvaluationProperties	EvaluationProperties
self	string (uri)	このエンティティの場所。
status	Status	ステータス API の現在の状態について説明する
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

Object

EvaluationLinks

名前	型	説明
files	string (uri)	このエンティティのすべてのファイルを取得する場所。詳細については、操作 "Evaluations_ListFiles" を参照してください。

EvaluationProperties

Object

EvaluationProperties

名前	型	説明
correctTokenCount1	integer (int32)	model1 によって正しく認識されたトークンの数。
correctTokenCount2	integer (int32)	model2 によって正しく認識されたトークンの数。
correctWordCount1	integer (int32)	model1 で正しく認識された単語の数。
correctWordCount2	integer (int32)	model2 で正しく認識された単語の数。
email	string	操作が完了した場合に電子メール通知を送信する電子メールアドレス。この値は、電子メールを正常に送信した後に削除されます。
error	EntityError	EntityError
sentenceCount1	integer (int32)	model1 で処理された文の数。
sentenceCount2	integer (int32)	model2 で処理された文の数。
sentenceErrorRate1	number (double)	model1 での認識の文エラー率。
sentenceErrorRate2	number (double)	model2 での認識の文エラー率。
tokenCount1	integer (int32)	model1 によって処理されたトークンの数。
tokenCount2	integer (int32)	model2 によって処理されたトークンの数。
tokenDeletionCount1	integer (int32)	model1 によって認識されたトークンの数 (削除)。
tokenDeletionCount2	integer (int32)	model2 によって認識されたトークンの数 (削除)。
tokenErrorRate1	number (double)	model1 での認識のトークンエラー率。
tokenErrorRate2	number (double)	model2 での認識のトークンエラー率。
tokenInsertionCount1	integer (int32)	model1 によって認識されたトークン (挿入) の数。
tokenInsertionCount2	integer (int32)	model2 によって認識されたトークンの数 (挿入)。
tokenSubstitutionCount1	integer (int32)	model1 によって認識されたトークンの数 (置換)。
tokenSubstitutionCount2	integer (int32)	model2 によって認識されたトークンの数 (置換)。
wordCount1	integer (int32)	model1 によって処理された単語の数。
wordCount2	integer (int32)	model2 で処理された単語の数。
wordDeletionCount1	integer (int32)	model1 によって認識された単語の数 (削除)。
wordDeletionCount2	integer (int32)	model2 によって認識された単語の数 (削除)。
wordErrorRate1	number (double)	model1 での認識の単語エラー率。
wordErrorRate2	number (double)	model2 を使用した認識の単語エラー率。
wordInsertionCount1	integer (int32)	model1 によって認識された単語の数 (挿入)。
wordInsertionCount2	integer (int32)	model2 によって認識された単語の数 (挿入)。
wordSubstitutionCount1	integer (int32)	model1 で認識された単語の数 (置換)。
wordSubstitutionCount2	integer (int32)	model2 で認識される単語の数 (置換)。

InnerError

Object

InnerError

名前	型	説明
code	DetailedErrorCode	DetailedErrorCode 詳細なエラーコード列挙型。
details	object	エラーや予想されるポリシーに関するその他のサポートの詳細。
innerError	InnerError	InnerError https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owで利用可能な Cognitive Services API ガイドラインに準拠した新しい内部エラー形式。これには、必須プロパティ ErrorCode、メッセージ、および省略可能なプロパティターゲット、details(キー値ペア)、内部エラー (入れ子にできます) が含まれます。
message	string	高レベルのエラーメッセージ。
target	string	エラーの原因。たとえば、無効なドキュメントの場合は "documents" または "document id" になります。

Status

列挙

ステータス

値	説明
NotStarted	実行時間の長い操作がまだ開始されていません。
Running	実行時間の長い操作は現在処理中です。
Succeeded	実行時間の長い操作が正常に完了しました。
Failed	実行時間の長い操作が失敗しました。

次の方法で共有

Evaluations - Create

URI パラメーター

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

Authorization

例

Create a evaluation

要求のサンプル

応答のサンプル

定義

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

InnerError

Status