Endpoints - List

リファレンス

サービス:: Azure AI Services

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

認証済みサブスクリプションのエンドポイントの一覧を取得します。

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints

省略可能なパラメーターを含む:

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip={skip}&top={top}&filter={filter}

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	サポートされている Cognitive Services エンドポイント (プロトコルとホスト名、例: https://westus.api.cognitive.microsoft.com)。
filter	query		string	使用可能なエンドポイントのサブセットを選択するためのフィルター式。 `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=locale eq 'en-US'`
skip	query		integer (int32)	スキップされるデータセットの数。
top	query		integer (int32)	スキップ後に含まれるデータセットの数。

応答

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

名前

型

説明

200 OK

PaginatedEndpoints

わかりました

ヘッダー

Retry-After: integer

Other Status Codes

Error

エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

Authorization

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

型: apiKey
/: header

例

Get all endpoints

Get all queued endpoints.

Get all endpoints

要求のサンプル

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

応答のサンプル

状態コード:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
        "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
      },
      "properties": {
        "timeToLive": "PT30M",
        "loggingEnabled": true
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
        "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
      },
      "properties": {
        "timeToLive": "PT30M",
        "loggingEnabled": false
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "NotStarted",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Get all queued endpoints.

要求のサンプル

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/endpoints?skip=0&top=2&filter=status%20eq%20'NotStarted'

応答のサンプル

状態コード:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      },
      "links": {
        "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
        "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
        "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
      },
      "properties": {
        "timeToLive": "PT30M",
        "loggingEnabled": false
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "NotStarted",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Speech endpoint",
      "description": "Example for speech endpoint"
    }
  ]
}

定義

名前	説明
DetailedErrorCode	DetailedErrorCode
Endpoint	エンドポイント
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EntityError	EntityError
EntityReference	EntityReference
Error	エラー
ErrorCode	エラーコード
InnerError	InnerError
PaginatedEndpoints	PaginatedEndpoints
Status	ステータス

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	サポートされていない時間範囲。

Endpoint

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 です。
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	EndpointLinks	EndpointLinks
locale	string minLength: 1	格納されているデータのロケール。
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string (uri)	このエンティティの場所。
status	Status	ステータス API の現在の状態について説明する
text	string	このエンドポイントの言語モデルを調整するために使用されるテキスト。

EndpointLinks

Object

EndpointLinks

名前	型	説明
logs	string (uri)	このエンドポイントのオーディオログと文字起こしログ。詳細については、操作 "Endpoints_ListLogs" を参照してください。
restConversation	string (uri)	最大 60 秒の要求の REST エンドポイント。
restDictation	string (uri)	最大 60 秒の要求の REST エンドポイント。句読点のディクテーションをサポートします。
restInteractive	string (uri)	最大 15 秒間の短い要求の REST エンドポイント。
webSocketConversation	string (uri)	複数の最終的な結果を含む長い要求の Speech SDK エンドポイント。
webSocketDictation	string (uri)	句読点のディクテーションをサポートする、複数の最終的な結果を持つ長い要求用の Speech SDK エンドポイント。
webSocketInteractive	string (uri)	1 回の最終結果で最大 15 秒間の短い要求の Speech SDK エンドポイント。

EndpointProperties

Object

EndpointProperties

名前	型	説明
email	string	操作が完了した場合に電子メール通知を送信する電子メールアドレス。この値は、電子メールを正常に送信した後に削除されます。
error	EntityError	EntityError
loggingEnabled	boolean	コンテンツログ (オーディオ & 文字起こし) が展開に使用されているかどうかを示す値。
timeToLive	string	エンドポイントがシステムに保持される期間。エンドポイントは、完了 (成功または失敗) 後に有効期間に達すると、自動的に削除されます。この値を設定しないか、0 に設定すると、自動削除が無効になります。サポートされている最も長い期間は 31 日です。期間は ISO 8601 期間としてエンコードされます (「PnYnMnDTnHnMnS」を参照 https://en.wikipedia.org/wiki/ISO_8601#Durations)。

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

列挙

エラーコード

値	説明
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" になります。

PaginatedEndpoints

Object

PaginatedEndpoints

名前	型	説明
@nextLink	string (uri)	使用可能なエンティティが他にある場合は、ページ分割された結果の次のセットへのリンク。それ以外の場合は null。
values	Endpoint[]	渡されたクエリパラメーター 'skip' と 'top' またはその既定値によって制限されるエンティティの一覧。ページ分割を使用してリストを反復処理し、エンティティを並列で削除すると、一部のエンティティが結果でスキップされます。クライアントでリストを作成し、完全なリストのフェッチ後に削除することをお勧めします。

名前

型

説明

@nextLink

string (uri)

使用可能なエンティティが他にある場合は、ページ分割された結果の次のセットへのリンク。それ以外の場合は null。

values

Endpoint[]

渡されたクエリパラメーター 'skip' と 'top' またはその既定値によって制限されるエンティティの一覧。

ページ分割を使用してリストを反復処理し、エンティティを並列で削除すると、一部のエンティティが結果でスキップされます。クライアントでリストを作成し、完全なリストのフェッチ後に削除することをお勧めします。

Status

列挙

ステータス

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

次の方法で共有

Endpoints - List

URI パラメーター

応答

セキュリティ

Ocp-Apim-Subscription-Key

Authorization

例

Get all endpoints

要求のサンプル

応答のサンプル

Get all queued endpoints.

要求のサンプル

応答のサンプル

定義

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

PaginatedEndpoints

Status

その他のリソース