Evaluations - Update

リファレンス

サービス:: Azure AI Services

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

id によって識別される評価の変更可能な詳細をUpdatesします。

PATCH {endpoint}/speechtotext/v3.2-preview.2/evaluations/{id}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名など)。 https://westus.api.cognitive.microsoft.com
id	path	True	string uuid	評価の識別子。

要求本文

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

名前	型	説明
customProperties	object	このエンティティのカスタムプロパティ。許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。
description	string	オブジェクトの説明。
displayName	string	オブジェクトの名前。
project	EntityReference	EntityReference

応答

名前	型	説明
200 OK	Evaluation	OK ヘッダー Retry-After: integer
Other Status Codes	Error	エラーが発生しました。

名前

型

説明

200 OK

Evaluation

ヘッダー

Retry-After: integer

Other Status Codes

Error

エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

Authorization

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

型: apiKey
/: header

例

Update a evaluation

要求のサンプル

HTTP

PATCH {endpoint}/speechtotext/v3.2-preview.2/evaluations/1c50ce42-6ab7-454f-8c39-54a752d1a5b6

{
  "displayName": "Updated evaluation",
  "description": "Updated evaluation description"
}

応答のサンプル

状態コード:: 200

{
  "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	ErrorCode
Evaluation	評価
EvaluationLinks	EvaluationLinks
EvaluationProperties	EvaluationProperties
EvaluationUpdate	EvaluationUpdate
InnerError	InnerError
Status	Status

DetailedErrorCode

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

EntityError

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

EntityReference

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

Error

エラー

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

ErrorCode

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

Evaluation

評価

名前	型	説明
createdDateTime	string	オブジェクトが作成されたときのタイムスタンプ。タイムスタンプは、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	オブジェクトの表示名。
lastActionDateTime	string	現在の状態が入力されたときのタイムスタンプ。タイムスタンプは、ISO 8601 の日付と時刻の形式 ("YYYY-MM-DDThh:mm:ssZ"、を参照) https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representationsとしてエンコードされます。
links	EvaluationLinks	EvaluationLinks
locale	string	包含データのロケール。
model1	EntityReference	EntityReference
model2	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EvaluationProperties	EvaluationProperties
self	string	このエンティティの場所。
status	Status	Status API の現在の状態について説明する
transcription1	EntityReference	EntityReference
transcription2	EntityReference	EntityReference

EvaluationLinks

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

EvaluationProperties

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

EvaluationUpdate

名前	型	説明
customProperties	object	このエンティティのカスタムプロパティ。許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。
description	string	オブジェクトの説明。
displayName	string	オブジェクトの名前。
project	EntityReference	EntityReference

InnerError

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

Status

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

次の方法で共有

Evaluations - Update

URI パラメーター

要求本文

応答

セキュリティ

Ocp-Apim-Subscription-Key

Authorization

例

Update a evaluation

要求のサンプル

応答のサンプル

定義

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

Evaluation

EvaluationLinks

EvaluationProperties

EvaluationUpdate

InnerError

Status

その他のリソース