Projects - List Endpoints

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

指定したプロジェクトのエンドポイントの一覧を取得します。

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/endpoints
省略可能なパラメーターを含む: 
GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/endpoints?skip={skip}&top={top}&filter={filter}

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

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

string

uuid

プロジェクトの識別子。
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

OK

ヘッダー

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 {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/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"
}

定義

名前 説明
DetailedErrorCode

DetailedErrorCode
Endpoint

エンドポイント
EndpointLinks

EndpointLinks
EndpointProperties

EndpointProperties
EntityError

EntityError
EntityReference

EntityReference
Error

エラー
ErrorCode

ErrorCode
InnerError

InnerError
PaginatedEndpoints

PaginatedEndpoints
Status

Status

DetailedErrorCode

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

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

Endpoint

エンドポイント

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

EndpointLinks

EndpointLinks
locale

string

格納されているデータのロケール。
model

EntityReference

EntityReference
project

EntityReference

EntityReference
properties

EndpointProperties

EndpointProperties
self

string

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

Status

Status
API の現在の状態について説明する
text

string

このエンドポイントの言語モデルを適合させるために使用されるテキスト。

EndpointLinks

名前 型 説明
logs

string

このエンドポイントのオーディオログと文字起こしログ。 詳細については、操作 "Endpoints_ListLogs" を参照してください。
restConversation

string

最大 60 秒の要求の REST エンドポイント。
restDictation

string

最大 60 秒の要求の REST エンドポイント。句読点のディクテーションをサポートします。
restInteractive

string

最大 15 秒間の短い要求の REST エンドポイント。
webSocketConversation

string

複数の最終結果を含む長い要求の Speech SDK エンドポイント。
webSocketDictation

string

句読点のディクテーションをサポートする、複数の最終結果を持つ長い要求の Speech SDK エンドポイント。
webSocketInteractive

string

1 つの最終結果で最大 15 秒の短い要求の Speech SDK エンドポイント。

EndpointProperties

EndpointProperties

名前 型 説明
email

string

操作が完了した場合に電子メール通知を送信する電子メール アドレス。 値は、電子メールを正常に送信した後に削除されます。
error

EntityError

EntityError
loggingEnabled

boolean

コンテンツ ログ (オーディオ & 文字起こし) が展開に使用されているかどうかを示す値。
timeToLive

string

エンドポイントがシステムに保持される期間。 エンドポイントは、完了 (成功または失敗) 後の有効期間に達すると、自動的に削除されます。 この値を設定しないか、または 0 に設定しないと、自動削除が無効になります。 サポートされている最も長い期間は 31 日です。 期間は ISO 8601 期間としてエンコードされます (「PnYnMnDTnHnMnS」を参照)。https://en.wikipedia.org/wiki/ISO_8601#Durations

EntityError

EntityError

名前 型 説明
code

string

このエラーのコード。
message

string

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

EntityReference

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

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

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

InnerError

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

PaginatedEndpoints

PaginatedEndpoints

名前 型 説明
@nextLink

string

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

Endpoint[]

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

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

Status

Status

名前 型 説明
Failed

string

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

string

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

string

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

string

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