Поделиться через

Projects - Update

Служба:
Azure AI Services
Версия API:
v3.2-preview.2

Обновляет проект, определенный заданным идентификатором.

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

Укажите ключ учетной записи Cognitive Services здесь.

Тип: apiKey
В: header

Authorization

Предоставьте маркер доступа из JWT, возвращаемого stS этого региона. Обязательно добавьте область управления в маркер, добавив следующую строку запроса к URL-адресу STS: ?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

Значение Описание
InvalidParameterValue

Недопустимое значение параметра.
InvalidRequestBodyFormat

Недопустимый формат текста запроса.
EmptyRequest

Пустой запрос.
MissingInputRecords

Отсутствуют входные записи.
InvalidDocument

Недопустимый документ.
ModelVersionIncorrect

Неправильная версия модели.
InvalidDocumentBatch

Недопустимый пакет документов.
UnsupportedLanguageCode

Неподдерживаемый код языка.
DataImportFailed

Сбой импорта данных.
InUseViolation

Нарушение использования.
InvalidLocale

Недопустимый языковой стандарт.
InvalidBaseModel

Недопустимая базовая модель.
InvalidAdaptationMapping

Недопустимое сопоставление адаптации.
InvalidDataset

Недопустимый набор данных.
InvalidTest

Недопустимый тест.
FailedDataset

Не удалось выполнить набор данных.
InvalidModel

Недопустимая модель.
InvalidTranscription

Недопустимое транскрибирование.
InvalidPayload

Недопустимые полезные данные.
InvalidParameter

Недопустимый параметр.
EndpointWithoutLogging

Конечная точка без ведения журнала.
InvalidPermissions

Недопустимые разрешения.
InvalidPrerequisite

Недопустимое условие.
InvalidProductId

Недопустимый идентификатор продукта.
InvalidSubscription

Недопустимая подписка.
InvalidProject

Недопустимый проект.
InvalidProjectKind

Недопустимый тип проекта.
InvalidRecordingsUri

Недопустимые URI записей.
OnlyOneOfUrlsOrContainerOrDataset

Только один url-адрес или контейнер или набор данных.
ExceededNumberOfRecordingsUris

Превышено количество uri записей.
ModelMismatch

Несоответствие модели.
ProjectGenderMismatch

Несоответствие пола проекта.
ModelDeprecated

Модель устарела.
ModelExists

Существует модель.
ModelNotDeployable

Модель недоступна для развертывания.
EndpointNotUpdatable

Конечная точка не обновляемая.
SingleDefaultEndpoint

Одна конечная точка по умолчанию.
EndpointCannotBeDefault

Конечная точка не может быть по умолчанию.
InvalidModelUri

Недопустимый универсальный код ресурса (URI) модели.
SubscriptionNotFound

Подписка не найдена.
QuotaViolation

Нарушение квоты.
UnsupportedDelta

Неподдерживаемые разностные данные.
UnsupportedFilter

Неподдерживаемый фильтр.
UnsupportedPagination

Неподдерживаемая разбивка на страницы.
UnsupportedDynamicConfiguration

Неподдерживаемая динамическая конфигурация.
UnsupportedOrderBy

Неподдерживаемый заказ.
NoUtf8WithBom

Нет utf8 с бомом.
ModelDeploymentNotCompleteState

Развертывание модели не завершено.
SkuLimitsExist

Существуют ограничения SKU.
DeployingFailedModel

Развертывание неудачной модели.
UnsupportedTimeRange

Неподдерживаемый диапазон времени.
InvalidLogDate

Недопустимая дата журнала.
InvalidLogId

Недопустимый идентификатор журнала.
InvalidLogStartTime

Недопустимое время запуска журнала.
InvalidLogEndTime

Недопустимое время окончания журнала.
InvalidTopForLogs

Недопустимое начало для журналов.
InvalidSkipTokenForLogs

Недопустимый маркер пропуска для журналов.
DeleteNotAllowed

Удалить не разрешено.
Forbidden

Запретный.
DeployNotAllowed

Развертывание не разрешено.
UnexpectedError

Непредвиденная ошибка.
InvalidCollection

Недопустимая коллекция.
InvalidCallbackUri

Недопустимый универсальный код ресурса (URI) обратного вызова.
InvalidSasValidityDuration

Недопустимая длительность действия sas.
InaccessibleCustomerStorage

Недоступное хранилище клиентов.
UnsupportedClassBasedAdaptation

Неподдерживаемая адаптация на основе класса.
InvalidWebHookEventKind

Недопустимый тип события веб-перехватчика.
InvalidTimeToLive

Недопустимое время жизни.
InvalidSourceAzureResourceId

Недопустимый исходный идентификатор ресурса Azure.
ModelCopyOperationExists

Существует операция копирования модели.

Error

Object

Ошибка

Имя Тип Описание
code

ErrorCode

Код ошибки
Коды ошибок высокого уровня.
details

Error[]

Дополнительные сведения о поддержке ошибок и (или) ожидаемых политик.
innerError

InnerError

InnerError
Новый формат внутренней ошибки, соответствующий рекомендациям ПО API Cognitive Services, который доступен в https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Это содержит обязательные свойства ErrorCode, сообщение и необязательные свойства, сведения (пара значений ключа), внутренняя ошибка (это может быть вложено).
message

string

Сообщение об ошибке высокого уровня.
target

string

Источник ошибки. Например, это будет "документы" или "идентификатор документа" в случае недопустимого документа.

ErrorCode

Перечисление

Код ошибки

Значение Описание
InvalidRequest

Представляет недопустимый код ошибки запроса.
InvalidArgument

Представляет недопустимый код ошибки аргумента.
InternalServerError

Представляет код ошибки внутреннего сервера.
ServiceUnavailable

Представляет недоступный код ошибки службы.
NotFound

Представление не найденного кода ошибки.
PipelineError

Представляет код ошибки конвейера.
Conflict

Представляет код ошибки конфликта.
InternalCommunicationFailed

Представляет код ошибки внутренней связи.
Forbidden

Представляет запрещенный код ошибки.
NotAllowed

Представляет недопустимый код ошибки.
Unauthorized

Представляет несанкционированный код ошибки.
UnsupportedMediaType

Представляет неподдерживаемый код ошибки типа носителя.
TooManyRequests

Представление слишком большого количества запросов кода ошибки.
UnprocessableEntity

Представляет код ошибки необработанной сущности.

InnerError

Object

InnerError

Имя Тип Описание
code

DetailedErrorCode

DetailedErrorCode
Подробный код ошибки перечисления.
details

object

Дополнительные сведения о поддержке ошибок и (или) ожидаемых политик.
innerError

InnerError

InnerError
Новый формат внутренней ошибки, соответствующий рекомендациям ПО API Cognitive Services, который доступен в https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Это содержит обязательные свойства ErrorCode, сообщение и необязательные свойства, сведения (пара значений ключа), внутренняя ошибка (это может быть вложено).
message

string

Сообщение об ошибке высокого уровня.
target

string

Источник ошибки. Например, это будет "документы" или "идентификатор документа" в случае недопустимого документа.

Project

Object

Проект

Имя Тип Описание
createdDateTime

string (date-time)

Метка времени при создании объекта. Метка времени закодирована как формат даты и времени ISO 8601 ("ГГГГ-ММ-DDThh:мм: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

Имя объекта.