Transcriptions - Update

Serviço:: Azure AI Services

Versão da API:: v3.2-preview.2

Atualiza os detalhes mutáveis da transcrição identificada pelo seu ID.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	O identificador da transcrição.

Corpo do Pedido

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

Name	Tipo	Description
customProperties	object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
description	string	A descrição do objeto.
displayName	string	O nome do objeto.
project	EntityReference	EntidadeReferência

Respostas

Name	Tipo	Description
200 OK	Transcription	OK Cabeçalhos Retry-After: integer
Other Status Codes	Error	Ocorreu um erro.

Name

Tipo

Description

200 OK

Transcription

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da sua conta de serviços cognitivos aqui.

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT retornado pelo STS desta região. Certifique-se de adicionar o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Update a transcription

Pedido de amostra

HTTP

PATCH {endpoint}/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683

{
  "displayName": "Updated transcription name",
  "description": "Updated transcription description",
  "customProperties": {
    "key": "value"
  }
}

Resposta da amostra

Código de estado:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files"
  },
  "properties": {
    "diarizationEnabled": false,
    "wordLevelTimestampsEnabled": false,
    "displayFormWordLevelTimestampsEnabled": false,
    "channels": [
      0,
      1
    ],
    "punctuationMode": "DictatedAndAutomatic",
    "profanityFilterMode": "Masked",
    "duration": "PT42S"
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Transcription using adapted model en-US",
  "customProperties": {
    "key": "value"
  }
}

Definições

Name	Description
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizaçãoPropriedades
DiarizationSpeakersProperties	DiarizationSpeakersProperties
EntityError	EntityError
EntityReference	EntidadeReferência
Error	Erro
ErrorCode	Código de erro
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	PontuaçãoModo de Pontuação
Status	Situação
Transcription	Transcrição
TranscriptionLinks	TranscriçãoLinks
TranscriptionProperties	TranscriçãoPropriedades
TranscriptionUpdate	TranscriçãoAtualização

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
InvalidParameterValue	Valor de parâmetro inválido.
InvalidRequestBodyFormat	Formato de corpo de solicitação inválido.
EmptyRequest	Pedido vazio.
MissingInputRecords	Registros de entrada ausentes.
InvalidDocument	Documento inválido.
ModelVersionIncorrect	Versão do modelo incorreta.
InvalidDocumentBatch	Lote de documentos inválido.
UnsupportedLanguageCode	Código de idioma não suportado.
DataImportFailed	Falha na importação de dados.
InUseViolation	Violação em uso.
InvalidLocale	Localidade inválida.
InvalidBaseModel	Modelo base inválido.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidDataset	Conjunto de dados inválido.
InvalidTest	Teste inválido.
FailedDataset	Conjunto de dados com falha.
InvalidModel	Modelo inválido.
InvalidTranscription	Transcrição inválida.
InvalidPayload	Carga útil inválida.
InvalidParameter	Parâmetro inválido.
EndpointWithoutLogging	Ponto de extremidade sem registro.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválida.
InvalidSubscription	Subscrição inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	Gravações inválidas uri.
OnlyOneOfUrlsOrContainerOrDataset	Apenas um dos urls ou contêiner ou conjunto de dados.
ExceededNumberOfRecordingsUris	Excedeu o número de gravações uris.
ModelMismatch	Incompatibilidade de modelos.
ProjectGenderMismatch	Desfasamento entre homens e mulheres no projeto.
ModelDeprecated	Modelo preterido.
ModelExists	Modelo existe.
ModelNotDeployable	Modelo não implantável.
EndpointNotUpdatable	Ponto final não atualizável.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
InvalidModelUri	Uri de modelo inválido.
SubscriptionNotFound	Subscrição não encontrada.
QuotaViolation	Violação de quotas.
UnsupportedDelta	Delta não suportado.
UnsupportedFilter	Filtro não suportado.
UnsupportedPagination	Paginação não suportada.
UnsupportedDynamicConfiguration	Configuração dinâmica não suportada.
UnsupportedOrderBy	Ordem não suportada por.
NoUtf8WithBom	Não utf8 com bom.
ModelDeploymentNotCompleteState	Implantação do modelo não concluída estado.
SkuLimitsExist	Existem limites de Sku.
DeployingFailedModel	Implantação de modelo com falha.
UnsupportedTimeRange	Intervalo de tempo não suportado.
InvalidLogDate	Data de registo inválida.
InvalidLogId	ID de log inválido.
InvalidLogStartTime	Hora de início de log inválida.
InvalidLogEndTime	Hora de fim de log inválida.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidSkipTokenForLogs	Token de pulo inválido para logs.
DeleteNotAllowed	Excluir não permitido.
Forbidden	Proibido.
DeployNotAllowed	Implantação não permitida.
UnexpectedError	Erro inesperado.
InvalidCollection	Coleção inválida.
InvalidCallbackUri	Uri de retorno de chamada inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InaccessibleCustomerStorage	Armazenamento inacessível do cliente.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
InvalidWebHookEventKind	Tipo de evento de gancho da Web inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidSourceAzureResourceId	ID de recurso do Azure de origem inválida.
ModelCopyOperationExists	A operação de cópia do modelo existe.

DiarizationProperties

Object

DiarizaçãoPropriedades

Name	Tipo	Description
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Object

DiarizationSpeakersProperties

Name	Tipo	Description
maxCount	integer (int32) minimum: 1	O número máximo de falantes para diarização. Deve ser menor que 36 e maior ou igual à propriedade minSpeakers.
minCount	integer (int32) minimum: 1	Uma dica para o número mínimo de falantes para diarização. Deve ser menor ou igual à propriedade maxSpeakers.

EntityError

Object

EntityError

Name	Tipo	Description
code	string	O código deste erro.
message	string	A mensagem para este erro.

EntityReference

Object

EntidadeReferência

Name	Tipo	Description
self	string (uri)	A localização da entidade referenciada.

Error

Object

Erro

Name	Tipo	Description
code	ErrorCode	Código de erro Códigos de erro de alto nível.
details	Error[]	Detalhes adicionais de suporte sobre o erro e/ou políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, mensagem e destino de propriedades opcionais, detalhes (par de valores de chave), erro interno (isso pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seria "documentos" ou "id do documento" no caso de documento inválido.

ErrorCode

Enumeração

Código de erro

Valor	Description
InvalidRequest	Representando o código de erro de solicitação inválida.
InvalidArgument	Representando o código de erro de argumento inválido.
InternalServerError	Representando o código de erro interno do servidor.
ServiceUnavailable	Representando o código de erro indisponível do serviço.
NotFound	Representando o código de erro não encontrado.
PipelineError	Representando o código de erro do pipeline.
Conflict	Representando o código de erro de conflito.
InternalCommunicationFailed	Representando o código de erro de falha de comunicação interna.
Forbidden	Representando o código de erro proibido.
NotAllowed	Representando o código de erro não permitido.
Unauthorized	Representando o código de erro não autorizado.
UnsupportedMediaType	Representando o código de erro de tipo de mídia não suportado.
TooManyRequests	Representando o código de erro de muitas solicitações.
UnprocessableEntity	Representando o código de erro de entidade não processável.

InnerError

Object

InnerError

Name	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Código de erro detalhado enum.
details	object	Detalhes adicionais de suporte sobre o erro e/ou políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API de Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Isso contém as propriedades necessárias ErrorCode, mensagem e destino de propriedades opcionais, detalhes (par de valores de chave), erro interno (isso pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seria "documentos" ou "id do documento" no caso de documento inválido.

LanguageIdentificationMode

Enumeração

LanguageIdentificationMode

Valor	Description
Continuous	Identificação contínua do idioma (padrão).
Single	Identificação de uma única língua.

LanguageIdentificationProperties

Object

LanguageIdentificationProperties

Name	Tipo	Default value	Description
candidateLocales	string[]		As localidades candidatas para identificação de idioma (exemplo ["en-US", "de-DE", "es-ES"]). Um mínimo de 2 e um máximo de 10 localidades candidatas, incluindo a localidade principal para a transcrição, são suportados.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode O modo usado para a identificação do idioma.
speechModelMapping	<string, EntityReference>		Um mapeamento opcional de localidades para entidades de modelo de fala. Se nenhum modelo for fornecido para uma localidade, o modelo base padrão será usado. As chaves devem ser localidades contidas nas localidades candidatas, os valores são entidades para modelos das respetivas localidades.

ProfanityFilterMode

Enumeração

ProfanityFilterMode

Valor	Description
None	Desative a filtragem de palavrões.
Removed	Remova os palavrões.
Tags	Adicione tags XML de "palavrões"</Profanity>
Masked	Mascare os palavrões com * exceto da primeira letra, por exemplo, f***

PunctuationMode

Enumeração

PontuaçãoModo de Pontuação

Valor	Description
None	Sem pontuação.
Dictated	Apenas sinais de pontuação ditados, ou seja, pontuação explícita.
Automatic	Pontuação automática.
DictatedAndAutomatic	Sinais de pontuação ditados ou pontuação automática.

Status

Enumeração

Situação

Valor	Description
NotStarted	A operação de longa duração ainda não começou.
Running	A operação de longa duração está atualmente em processamento.
Succeeded	A operação de longa duração foi concluída com êxito.
Failed	A operação de longa duração falhou.

Transcription

Object

Transcrição

Name	Tipo	Description
contentContainerUrl	string (uri)	Uma URL para um contêiner de blob do Azure que contém os arquivos de áudio. Um contêiner pode ter um tamanho máximo de 5 GB e um número máximo de 10000 blobs. O tamanho máximo de um blob é de 2,5 GB. O SAS do contêiner deve conter as permissões 'r' (leitura) e 'l' (lista). Esta propriedade não será devolvida em resposta.
contentUrls	string[] (uri)	Uma lista de urls de conteúdo para obter arquivos de áudio para transcrever. Até 1000 urls são permitidos. Esta propriedade não será devolvida em resposta.
createdDateTime	string (date-time)	O carimbo de data/hora quando o objeto foi criado. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
dataset	EntityReference	EntidadeReferência
description	string	A descrição do objeto.
displayName	string minLength: 1	O nome para exibição do objeto.
lastActionDateTime	string (date-time)	O carimbo de data/hora quando o status atual foi inserido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	TranscriçãoLinks
locale	string minLength: 1	A localidade dos dados contidos. Se a Identificação de Idioma for usada, essa localidade será usada para transcrever fala para a qual nenhum idioma pôde ser detetado.
model	EntityReference	EntidadeReferência
project	EntityReference	EntidadeReferência
properties	TranscriptionProperties	TranscriçãoPropriedades
self	string (uri)	A localização desta entidade.
status	Status	Situação Descrever o estado atual da API

TranscriptionLinks

Object

TranscriçãoLinks

Name	Tipo	Description
files	string (uri)	O local para obter todos os arquivos desta entidade. Consulte a operação "Transcriptions_ListFiles" para obter mais detalhes.

TranscriptionProperties

Object

TranscriçãoPropriedades

Name	Tipo	Description
channels	integer[] (int32)	Uma coleção dos números de canal solicitados. No caso padrão, os canais 0 e 1 são considerados.
destinationContainerUrl	string (uri)	O contêiner de destino solicitado. Observações Quando um contêiner de destino é usado em combinação com um `timeToLive`, os metadados de uma transcrição serão excluídos normalmente, mas os dados armazenados no contêiner de destino, incluindo os resultados da transcrição, permanecerão intocados, porque nenhuma permissão de exclusão é necessária para esse contêiner. Para dar suporte à limpeza automática, configure o tempo de vida do blob no contêiner ou use "Bring your own Storage (BYOS)" em vez de `destinationContainerUrl`, onde os blobs podem ser limpos.
diarization	DiarizationProperties	DiarizaçãoPropriedades
diarizationEnabled	boolean	Um valor que indica se a diarização (identificação do orador) é solicitada. O valor predefinido é `false`. Se este campo estiver definido como true e o sistema de diarização melhorado for configurado especificando `DiarizationProperties`, o sistema de diarização melhorado fornecerá diarização para uma gama configurável de altifalantes. Se este campo estiver definido como true e o sistema de diarização melhorado não estiver ativado (não especificando `DiarizationProperties`), o sistema de diarização básico distinguirá entre até dois altifalantes. Não são aplicadas taxas adicionais para a diarização básica. O sistema básico de diarização foi preterido e será removido na próxima versão principal da API. Essa configuração `diarizationEnabled` também será removida.
displayFormWordLevelTimestampsEnabled	boolean	Um valor que indica se os carimbos de data/hora no nível da palavra para o formulário de exibição são solicitados. O valor predefinido é `false`.
duration	string	A duração da transcrição. A duração é codificada como duração ISO 8601 ("PnYnMnDTnHnMnS", ver https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	O endereço de e-mail para o qual enviar notificações por e-mail caso a operação seja concluída. O valor será removido após o envio bem-sucedido do e-mail.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Modo de filtragem de palavrões.
punctuationMode	PunctuationMode	PontuaçãoModo de Pontuação O modo usado para pontuação.
timeToLive	string	Por quanto tempo a transcrição será mantida no sistema após sua conclusão. Uma vez que a transcrição atinja o tempo de vida após a conclusão (bem-sucedida ou falhada), ela será automaticamente excluída. Não definir esse valor ou defini-lo como 0 desativará a exclusão automática. A duração suportada mais longa é de 31 dias. A duração é codificada como duração ISO 8601 ("PnYnMnDTnHnMnS", ver https://en.wikipedia.org/wiki/ISO_8601#Durations).
wordLevelTimestampsEnabled	boolean	Um valor que indica se os carimbos de data/hora no nível da palavra são solicitados. O valor predefinido é `false`.

TranscriptionUpdate

Object

TranscriçãoAtualização

Name	Tipo	Description
customProperties	object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo do valor permitido é de 256 caracteres e a contagem de entradas permitidas é de 10.
description	string	A descrição do objeto.
displayName	string	O nome do objeto.
project	EntityReference	EntidadeReferência

Transcriptions - Update

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Update a transcription

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Observações

TranscriptionUpdate