通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Projects - Update

  • 参考
服务:
Azure AI Services
API 版本:
v3.1

更新由给定 ID 标识的项目。

PATCH {endpoint}/speechtotext/v3.1/projects/{id}

URI 参数

名称 在 必需 类型 说明
endpoint
 path True

string

支持的认知服务终结点 (协议和主机名，例如： 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.1/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.1/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
    "datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
    "models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
    "endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
    "transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/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

ErrorCode
InnerError

InnerError
Project

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

日志的跳过令牌无效。
InvalidSubscription

无效的订阅。
InvalidTest

测试无效。
InvalidTimeToLive

生存时间无效。
InvalidTopForLogs

日志顶部无效。
InvalidTranscription

听录无效。
InvalidWebHookEventKind

Web 挂钩事件类型无效。
MissingInputRecords

缺少输入记录。
ModelDeploymentNotCompleteState

模型部署未完成状态。
ModelDeprecated

模型已弃用。
ModelExists

模型存在。
ModelMismatch

模型不匹配。
ModelNotDeployable

模型不可部署。
ModelVersionIncorrect

模型版本不正确。
NoUtf8WithBom

没有带有 bom 的 utf8。
OnlyOneOfUrlsOrContainerOrDataset

只有一个 URL 或容器或数据集。
ProjectGenderMismatch

项目性别不匹配。
QuotaViolation

配额冲突。
SingleDefaultEndpoint

单个默认终结点。
SkuLimitsExist

存在 SKU 限制。
SubscriptionNotFound

找不到订阅。
UnexpectedError

意外错误。
UnsupportedClassBasedAdaptation

不支持的基于类的适应。
UnsupportedDelta

不支持的增量。
UnsupportedDynamicConfiguration

不支持的动态配置。
UnsupportedFilter

不支持的筛选器。
UnsupportedLanguageCode

不支持的语言代码。
UnsupportedOrderBy

不支持的订单依据。
UnsupportedPagination

不支持的分页。
UnsupportedTimeRange

不支持的时间范围。

Error

Object

错误

名称 类型 说明
code

ErrorCode

ErrorCode
高级错误代码。
details

Error[]

有关错误和/或预期策略的其他支持性详细信息。
innerError

InnerError

InnerError
新的内部错误格式，符合认知服务 API 指南，可从 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow获取。 这包含必需的属性 ErrorCode、消息和可选属性目标、详细信息（键值对）、内部错误（可以嵌套）。
message

string

高级别错误消息。
target

string

错误的源。 例如，如果文档无效，应为“文档”或“文档 ID”。

ErrorCode

枚举

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
新的内部错误格式，符合认知服务 API 指南，可从 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow获取。 这包含必需的属性 ErrorCode、消息和可选属性目标、详细信息（键值对）、内部错误（可以嵌套）。
message

string

高级别错误消息。
target

string

错误的源。 例如，如果文档无效，应为“文档”或“文档 ID”。

Project

Object

Project

名称 类型 说明
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

对象的名称。