次の方法で共有

Projects - Update

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

指定された ID で識別されるプロジェクトを更新します。

PATCH {endpoint}/speechtotext/v3.2-preview.2/projects/{id}

URI パラメーター

名前 / 必須 型 説明
endpoint
 path True

string

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

string (uuid)

プロジェクトの識別子。

要求本文

Media Types: "application/json", "application/merge-patch+json"

名前 型 説明
customProperties

object

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

string

オブジェクトの説明。
displayName

string

オブジェクトの名前。

応答

名前 型 説明
200 OK

Project

わかりました
Other Status Codes

Error

エラーが発生しました。

セキュリティ

Ocp-Apim-Subscription-Key

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

型: apiKey
/: header

Authorization

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

型: apiKey
/: header

例

Update a project

要求のサンプル

PATCH {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0

{
  "displayName": "My updated speech project",
  "customProperties": {
    "key": "value"
  }
}

応答のサンプル

状態コード:
200 
{
  "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"
}

定義

名前 説明
DetailedErrorCode

DetailedErrorCode
Error

エラー
ErrorCode

エラーコード
InnerError

InnerError
Project

プロジェクト
ProjectLinks

ProjectLinks
ProjectProperties

ProjectProperties
ProjectUpdate

ProjectUpdate

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

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)

このエンティティの場所。
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)

このプロジェクトに関連付けられている文字起こしの数。

ProjectUpdate

Object

ProjectUpdate

名前 型 説明
customProperties

object

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

string

オブジェクトの説明。
displayName

string

オブジェクトの名前。