Projects - List

  • リファレンス
サービス:
Azure AI Services
API バージョン:
2024-02-01-preview

認証された Speech サービス リソースのプロジェクトの一覧を取得します。

GET {endpoint}/customvoice/projects?api-version=2024-02-01-preview
省略可能なパラメーターを含む: 
GET {endpoint}/customvoice/projects?skip={skip}&maxpagesize={maxpagesize}&filter={filter}&api-version=2024-02-01-preview

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

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

string

この操作に使用する API バージョン。
filter
 query

string

フィルター条件。

  • サポートされているプロパティ: projectId、createdDateTime、locale、kind

  • 演算子：

    • eq、ne は、すべてのプロパティでサポートされています。

    • gt、ge、lt、le は createdDateTime でサポートされています。

  • 例:

    • filter=projectId eq 'Jessica' (プロジェクト ID でフィルター処理)

    • filter=kind eq 'ProfessionalVoice' (種類でプロジェクトをフィルター処理)

    • filter=locale eq 'en-US' (ロケール別にトレーニング セットとモデルをフィルター処理)

    • filter=createdDateTime gt 2022-12-30T23:59:59.99Z (2023-11-01 より後のリソース作成時刻をフィルター処理)
maxpagesize
 query

integer

int32

1 つの応答に含める項目の最大数。
skip
 query

integer

int32

スキップする結果項目の数。

要求ヘッダー

名前 必須 型 説明
Ocp-Apim-Subscription-Key True

string

ここで Speech リソース キーを指定します。

応答

名前 型 説明
200 OK

PaginatedProjects

Success
Other Status Codes

ErrorResponse

エラーが発生しました。

ヘッダー

x-ms-error-code: string

セキュリティ

Ocp-Apim-Subscription-Key

ここで Speech リソース キーを指定します。

型: apiKey
/: header

例

Get all projects

要求のサンプル

GET {endpoint}/customvoice/projects?api-version=2024-02-01-preview

応答のサンプル

状態コード:
200 
{
  "value": [
    {
      "id": "Jessica",
      "description": "Project for Jessica Voice",
      "kind": "ProfessionalVoice",
      "createdDateTime": "2023-04-01T05:30:00.000Z"
    },
    {
      "id": "PersonalVoice",
      "description": "Project for personal voice",
      "kind": "PersonalVoice",
      "createdDateTime": "2023-04-01T05:30:00.000Z"
    }
  ],
  "nextLink": "https://eastus.api.cognitive.microsoft.com/customvoice/projects?skip=2&maxpagesize=2&api-version=2024-02-01-preview"
}

定義

名前 説明
Error

最上位レベルのエラーは、 で利用可能な Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、エラー コード、メッセージ、詳細、ターゲット、およびよりわかりやすい詳細を含む内部エラーを含む最上位レベルのエラーが含まれます。
ErrorCode

最上位のエラー コード
ErrorResponse

エラー応答は、 で利用可能な Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。
InnerError

内部エラーは、 で使用できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、必須のプロパティ エラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (これは入れ子にできます) が含まれます。
PaginatedProjects

ページ分割されたプロジェクトの一覧
Project

Project オブジェクト。 同意、トレーニング セット、モデル、エンドポイントは、プロジェクトに編成されます。
ProjectKind

プロジェクトの種類

Error

最上位レベルのエラーは、 で利用可能な Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、エラー コード、メッセージ、詳細、ターゲット、およびよりわかりやすい詳細を含む内部エラーを含む最上位レベルのエラーが含まれます。

名前 型 説明
code

ErrorCode

最上位のエラー コード
details

Error[]

エラーや予想されるポリシーに関するその他のサポートの詳細。
innererror

InnerError

内部エラーは、 で使用できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、必須のプロパティ エラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (これは入れ子にできます) が含まれます。
message

string

最上位レベルのエラー メッセージ。
target

string

エラーのソースです。 たとえば、無効なモデルの場合は、"model" または "model id" になります。

ErrorCode

最上位のエラー コード

名前 型 説明
BadArgument

string

BadRequest

string

Forbidden

string

InternalServerError

string

NotFound

string

ServiceUnavailable

string

TooManyRequests

string

Unauthorized

string

UnsupportedMediaType

string

ErrorResponse

エラー応答は、 で利用可能な Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。

名前 型 説明
error

Error

最上位レベルのエラーは、 で利用可能な Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、エラー コード、メッセージ、詳細、ターゲット、およびよりわかりやすい詳細を含む内部エラーを含む最上位レベルのエラーが含まれます。

InnerError

内部エラーは、 で使用できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、必須のプロパティ エラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (これは入れ子にできます) が含まれます。

名前 型 説明
code

string

診断に役立つ詳細なエラー コード。
innererror

InnerError

内部エラーは、 で使用できる Microsoft Azure REST API ガイドラインに https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors従います。 これには、必須のプロパティ エラー コード、メッセージ、および省略可能なプロパティ ターゲット、内部エラー (これは入れ子にできます) が含まれます。
message

string

詳細なエラー メッセージ。
target

string

エラーのソースです。 たとえば、無効なモデルの場合は、"model" または "model id" になります。

PaginatedProjects

ページ分割されたプロジェクトの一覧

名前 型 説明
nextLink

string

次のページへのリンク。
value

Project[]

プロジェクト リスト

Project

Project オブジェクト。 同意、トレーニング セット、モデル、エンドポイントは、プロジェクトに編成されます。

名前 型 説明
createdDateTime

string

オブジェクトが作成されたときのタイムスタンプ。 タイムスタンプは、ISO 8601 の日付と時刻の形式 ("YYYY-MM-DDThh:mm:ssZ"、 を参照) https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representationsとしてエンコードされます。
description

string

プロジェクトの説明
displayName

string

プロジェクト名
id

string

リソースの ID
kind

ProjectKind

プロジェクトの種類

ProjectKind

プロジェクトの種類

名前 型 説明
PersonalVoice

string

ProfessionalVoice

string