次の方法で共有

Web Hooks - Create

  • リファレンス
サービス:
Azure AI Services
API バージョン:
v3.2-preview.2

新しい Web フックを作成します。
構成にプロパティ シークレットが存在し、空でない文字列が含まれている場合は、シークレットを HMAC キーとして使用してペイロードの SHA256 ハッシュを作成するために使用されます。 このハッシュは、登録された URL を呼び出すときに XMicrosoftSpeechServices-Signature ヘッダーとして設定されます。

登録された URL を呼び出すとき、要求には、登録されたイベントの種類のいずれかを含む X-MicrosoftSpeechServices-Event ヘッダーが含まれます。 登録されたイベントの種類ごとに 1 つの要求があります。

Web フックを正常に登録した後は、チャレンジ/応答が完了するまで使用できません。 これを行うには、validationToken というクエリ パラメーターを使用して、イベントの種類チャレンジを含む要求が行われます。 validationToken クエリ パラメーターの値を応答本文として含む 200 OK でチャレンジに応答します。 チャレンジ/応答が正常に完了すると、Web フックはイベントの受信を開始します。

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

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://westus.api.cognitive.microsoft.com)。

要求本文

名前 必須 型 説明
displayName True

string

minLength: 1

オブジェクトの表示名。
events True

WebHookEvents

WebHookEvents
webUrl True

string (uri)

登録されたイベントの POST 要求の送信先として使用される登録済み URL。
customProperties

object

このエンティティのカスタム プロパティ。 許可されるキーの最大長は 64 文字、最大許容値の長さは 256 文字、許可されるエントリの数は 10 です。
description

string

オブジェクトの説明。
properties

WebHookProperties

WebHookProperties

応答

名前 型 説明
201 Created

WebHook

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

ヘッダー

Location: string
Other Status Codes

Error

エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

Authorization

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

型: apiKey
/: header

例

Create a web hook

要求のサンプル

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

{
  "displayName": "TranscriptionCompletionWebHook",
  "properties": {
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "description": "I registered this URL to get a POST request for each completed transcription."
}

応答のサンプル

状態コード:
201 
Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d
{
  "displayName": "TranscriptionCompletionWebHook",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
  "links": {
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test",
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping"
  },
  "properties": {
    "apiVersion": "v3.2-preview.2",
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "description": "I registered this URL to get a POST request for each completed transcription.",
  "createdDateTime": "2018-11-11T00:00:00Z",
  "lastActionDateTime": "2018-11-28T00:00:00Z",
  "status": "NotStarted"
}

定義

名前 説明
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
Error

エラー
ErrorCode

エラーコード
InnerError

InnerError
Status

ステータス
WebHook

WebHook
WebHookEvents

WebHookEvents
WebHookLinks

WebHookLinks
WebHookProperties

WebHookProperties

DetailedErrorCode

列挙

DetailedErrorCode

値 説明
DataImportFailed

データのインポートに失敗しました。
DeleteNotAllowed

削除は許可されていません。
DeployNotAllowed

デプロイは許可されていません。
DeployingFailedModel

失敗したモデルのデプロイ。
EmptyRequest

空の要求。
EndpointCannotBeDefault

エンドポイントを既定にすることはできません。
EndpointNotUpdatable

エンドポイントは更新できません。
EndpointWithoutLogging

ログ記録なしのエンドポイント。
ExceededNumberOfRecordingsUris

記録 URI の数を超えました。
FailedDataset

失敗したデータセット。
Forbidden

禁じられた。
InUseViolation

使用中の違反。
InaccessibleCustomerStorage

お客様のストレージにアクセスできません。
InvalidAdaptationMapping

適応マッピングが無効です。
InvalidBaseModel

ベース モデルが無効です。
InvalidCallbackUri

コールバック URI が無効です。
InvalidCollection

コレクションが無効です。
InvalidDataset

データセットが無効です。
InvalidDocument

ドキュメントが無効です。
InvalidDocumentBatch

ドキュメント バッチが無効です。
InvalidLocale

ロケールが無効です。
InvalidLogDate

ログの日付が無効です。
InvalidLogEndTime

ログの終了時刻が無効です。
InvalidLogId

無効なログ ID です。
InvalidLogStartTime

ログの開始時刻が無効です。
InvalidModel

モデルが無効です。
InvalidModelUri

モデル URI が無効です。
InvalidParameter

パラメーターが無効です。
InvalidParameterValue

パラメーター値が無効です。
InvalidPayload

ペイロードが無効です。
InvalidPermissions

アクセス許可が無効です。
InvalidPrerequisite

前提条件が無効です。
InvalidProductId

製品 ID が無効です。
InvalidProject

プロジェクトが無効です。
InvalidProjectKind

プロジェクトの種類が無効です。
InvalidRecordingsUri

無効な記録 URI。
InvalidRequestBodyFormat

要求本文の形式が無効です。
InvalidSasValidityDuration

SAS の有効期間が無効です。
InvalidSkipTokenForLogs

ログのスキップ トークンが無効です。
InvalidSourceAzureResourceId

ソース Azure リソース ID が無効です。
InvalidSubscription

サブスクリプションが無効です。
InvalidTest

テストが無効です。
InvalidTimeToLive

有効期限が無効です。
InvalidTopForLogs

ログの top が無効です。
InvalidTranscription

文字起こしが無効です。
InvalidWebHookEventKind

Web フック イベントの種類が無効です。
MissingInputRecords

入力レコードがありません。
ModelCopyOperationExists

モデルのコピー操作が存在します。
ModelDeploymentNotCompleteState

モデルのデプロイが完了していない状態です。
ModelDeprecated

モデルは非推奨になりました。
ModelExists

モデルが存在します。
ModelMismatch

モデルの不一致。
ModelNotDeployable

モデルはデプロイできません。
ModelVersionIncorrect

モデルのバージョンが正しくありません。
NoUtf8WithBom

bom を含む utf8 はありません。
OnlyOneOfUrlsOrContainerOrDataset

URL またはコンテナーまたはデータセットのいずれか 1 つだけ。
ProjectGenderMismatch

プロジェクトの性別の不一致。
QuotaViolation

クォータ違反。
SingleDefaultEndpoint

単一の既定のエンドポイント。
SkuLimitsExist

SKU の制限が存在します。
SubscriptionNotFound

サブスクリプションが見つかりません。
UnexpectedError

予期しないエラー。
UnsupportedClassBasedAdaptation

サポートされていないクラス ベースの適応。
UnsupportedDelta

サポートされていないデルタ。
UnsupportedDynamicConfiguration

サポートされていない動的構成。
UnsupportedFilter

サポートされていないフィルター。
UnsupportedLanguageCode

サポートされていない言語コード。
UnsupportedOrderBy

サポートされていない注文者。
UnsupportedPagination

サポートされていない改ページ位置。
UnsupportedTimeRange

サポートされていない時間範囲。

EntityError

Object

EntityError

名前 型 説明
code

string

このエラーのコード。
message

string

このエラーのメッセージ。

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

列挙

エラーコード

値 説明
Conflict

競合エラー コードを表します。
Forbidden

禁止されているエラー コードを表します。
InternalCommunicationFailed

内部通信に失敗したエラー コードを表します。
InternalServerError

内部サーバー エラー コードを表します。
InvalidArgument

無効な引数のエラー コードを表します。
InvalidRequest

無効な要求エラー コードを表します。
NotAllowed

許可されていないエラー コードを表します。
NotFound

見つからないエラー コードを表します。
PipelineError

パイプライン エラー コードを表します。
ServiceUnavailable

サービスを使用できないエラー コードを表します。
TooManyRequests

要求の数が多すぎるエラー コードを表します。
Unauthorized

承認されていないエラー コードを表します。
UnprocessableEntity

処理不可能なエンティティ エラー コードを表します。
UnsupportedMediaType

サポートされていないメディアの種類のエラー コードを表します。

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

列挙

ステータス

値 説明
Failed

実行時間の長い操作が失敗しました。
NotStarted

実行時間の長い操作がまだ開始されていません。
Running

実行時間の長い操作は現在処理中です。
Succeeded

実行時間の長い操作が正常に完了しました。

WebHook

Object

WebHook

名前 型 説明
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 です。
description

string

オブジェクトの説明。
displayName

string

minLength: 1

オブジェクトの表示名。
events

WebHookEvents

WebHookEvents
lastActionDateTime

string (date-time)

現在の状態が入力されたときのタイムスタンプ。 タイムスタンプは ISO 8601 の日付と時刻の形式 ("YYYY-MM-DDThh:mm:ssZ"、 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations参照) としてエンコードされます。
links

WebHookLinks

WebHookLinks
properties

WebHookProperties

WebHookProperties
self

string (uri)

このエンティティの場所。
status

Status

ステータス
API の現在の状態について説明する
webUrl

string (uri)

登録されたイベントの POST 要求の送信先として使用される登録済み URL。

WebHookEvents

Object

WebHookEvents

名前 型 説明
challenge

boolean

datasetCompletion

boolean

datasetCreation

boolean

datasetDeletion

boolean

datasetProcessing

boolean

endpointCompletion

boolean

endpointCreation

boolean

endpointDeletion

boolean

endpointProcessing

boolean

evaluationCompletion

boolean

evaluationCreation

boolean

evaluationDeletion

boolean

evaluationProcessing

boolean

modelCompletion

boolean

modelCreation

boolean

modelDeletion

boolean

modelProcessing

boolean

ping

boolean

transcriptionCompletion

boolean

transcriptionCreation

boolean

transcriptionDeletion

boolean

transcriptionProcessing

boolean

Object

WebHookLinks

名前 型 説明
ping

string (uri)

Web フック登録の登録済み URL への ping イベントの送信をトリガーするために使用できる URL。 詳細については、操作 "WebHooks_Ping" を参照してください。
test

string (uri)

Web フック登録の登録済み URL へのテスト イベントの送信に使用できる URL。 詳細については、操作 "WebHooks_Test" を参照してください。

WebHookProperties

Object

WebHookProperties

名前 型 説明
apiVersion

string

Web フックが作成された API バージョン。 これにより、コールバック内のペイロードの形状が定義されます。 ペイロードの種類がサポートされなくなった場合、図形が変更され、それを使用する API バージョンが削除されるため (非推奨の後)、Web フックは無効になります。
error

EntityError

EntityError
secret

string

シークレットを HMAC キーとして使用してペイロードの SHA256 ハッシュを作成するために使用されるシークレット。 このハッシュは、登録された URL を呼び出すときに XMicrosoftSpeechServices-Signature ヘッダーとして設定されます。