Projects - List

リファレンス

サービス:: Azure AI Services

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

認証されたサブスクリプションのプロジェクトの一覧を取得します。

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

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

GET {endpoint}/speechtotext/v3.2-preview.2/projects?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, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=displayName eq 'My test'`
skip	query		integer (int32)	スキップされるデータセットの数。
top	query		integer (int32)	スキップ後に含まれるデータセットの数。

応答

名前	型	説明
200 OK	PaginatedProjects	わかりました
Other Status Codes	Error	エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

Authorization

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

型: apiKey
/: header

例

Get all projects

Get all projects created in 2018 or 2019

Get all projects

要求のサンプル

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3

応答のサンプル

状態コード:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "My speech project"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=3&top=3"
}

Get all projects created in 2018 or 2019

要求のサンプル

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z

応答のサンプル

状態コード:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2018-03-03T12:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2018-12-19T17:54:57Z",
      "locale": "en-US",
      "displayName": "My speech project"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
      "links": {
        "evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
        "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
        "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
        "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
        "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
      },
      "properties": {
        "datasetCount": 23,
        "evaluationCount": 42,
        "modelCount": 2,
        "transcriptionCount": 1994,
        "endpointCount": 12
      },
      "createdDateTime": "2019-02-01T00:45:27Z",
      "locale": "en-US",
      "displayName": "My speech project"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z"
}

定義

名前	説明
DetailedErrorCode	DetailedErrorCode
Error	エラー
ErrorCode	エラーコード
InnerError	InnerError
PaginatedProjects	PaginatedProjects
Project	プロジェクト
ProjectLinks	ProjectLinks
ProjectProperties	ProjectProperties

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

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

PaginatedProjects

Object

PaginatedProjects

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

名前

型

説明

@nextLink

string (uri)

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

values

Project[]

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

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

Project

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	オブジェクトの表示名。
links	ProjectLinks	ProjectLinks
locale	string minLength: 1	格納されているデータのロケール。
properties	ProjectProperties	ProjectProperties
self	string (uri)	このエンティティの場所。

ProjectLinks

Object

ProjectLinks

名前	型	説明
datasets	string (uri)	このプロジェクトのすべてのデータセットの一覧を取得する場所。詳細については、操作 "Projects_ListDatasets" を参照してください。
endpoints	string (uri)	このプロジェクトのすべてのエンドポイントの一覧を取得する場所。詳細については、操作 "Projects_ListEndpoints" を参照してください。
evaluations	string (uri)	このプロジェクトのすべての評価の一覧を取得する場所。詳細については、操作 "Projects_ListEvaluations" を参照してください。
models	string (uri)	このプロジェクトのすべてのモデルの一覧を取得する場所。詳細については、操作 "Projects_ListModels" を参照してください。
transcriptions	string (uri)	このプロジェクトのすべての文字起こしの一覧を取得する場所。詳細については、操作 "Projects_ListTranscriptions" を参照してください。

ProjectProperties

Object

ProjectProperties

名前	型	説明
datasetCount	integer (int32)	このプロジェクトに関連付けられているデータセットの数。
endpointCount	integer (int32)	このプロジェクトに関連付けられているエンドポイントの数。
evaluationCount	integer (int32)	このプロジェクトに関連付けられている評価の数。
modelCount	integer (int32)	このプロジェクトに関連付けられているモデルの数。
transcriptionCount	integer (int32)	このプロジェクトに関連付けられている文字起こしの数。

次の方法で共有

Projects - List

URI パラメーター

応答

セキュリティ

Ocp-Apim-Subscription-Key

Authorization

例

Get all projects

要求のサンプル

応答のサンプル

Get all projects created in 2018 or 2019

要求のサンプル

応答のサンプル

定義

DetailedErrorCode

Error

ErrorCode

InnerError

PaginatedProjects

Project

ProjectLinks

ProjectProperties

その他のリソース