Transcriptions - Update

Referência

Serviço:: Azure AI Services

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

Atualiza os detalhes mutáveis da transcrição identificada por sua ID.

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

Parâmetros de URI

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

Corpo da solicitação

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

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

Respostas

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

Nome

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 sua chave de 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. Adicione o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL do STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Update a transcription

Solicitação de exemplo

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 de exemplo

Código de status:: 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

Nome	Description
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
DiarizationSpeakersProperties	DiarizationSpeakersProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Erro
ErrorCode	ErrorCode
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	PunctuationMode
Status	Status
Transcription	Transcrição
TranscriptionLinks	TranscriptionLinks
TranscriptionProperties	TranscriptionProperties
TranscriptionUpdate	TranscriptionUpdate

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
DataImportFailed	Falha na importação de dados.
DeleteNotAllowed	Excluir não é permitido.
DeployNotAllowed	Implantação não permitida.
DeployingFailedModel	Implantação de modelo com falha.
EmptyRequest	Solicitação vazia.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
EndpointNotUpdatable	Ponto de extremidade não atualizável.
EndpointWithoutLogging	Ponto de extremidade sem registro em log.
ExceededNumberOfRecordingsUris	Número excedido de uris de gravações.
FailedDataset	Conjunto de dados com falha.
Forbidden	Negado.
InUseViolation	Violação de uso.
InaccessibleCustomerStorage	Armazenamento inacessível do cliente.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidBaseModel	Modelo base inválido.
InvalidCallbackUri	URI de retorno de chamada inválido.
InvalidCollection	Coleção inválida.
InvalidDataset	Conjunto de dados inválido.
InvalidDocument	Documento inválido.
InvalidDocumentBatch	Lote de Documentos inválido.
InvalidLocale	Localidade inválida.
InvalidLogDate	Data de log inválida.
InvalidLogEndTime	Hora de término do log inválida.
InvalidLogId	ID de log inválida.
InvalidLogStartTime	Hora de início do log inválida.
InvalidModel	Modelo inválido.
InvalidModelUri	URI de modelo inválido.
InvalidParameter	Parâmetro inválido.
InvalidParameterValue	Valor de parâmetro inválido.
InvalidPayload	Conteúdo inválido.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	URI de gravações inválidas.
InvalidRequestBodyFormat	Formato do corpo da solicitação inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InvalidSkipTokenForLogs	Token de ignorar inválido para logs.
InvalidSourceAzureResourceId	ID de recurso do Azure de origem inválida.
InvalidSubscription	Assinatura inválida.
InvalidTest	Teste inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidTranscription	Transcrição inválida.
InvalidWebHookEventKind	Tipo de evento de web hook inválido.
MissingInputRecords	Registros de entrada ausentes.
ModelCopyOperationExists	A operação de cópia de modelo existe.
ModelDeploymentNotCompleteState	O estado de implantação do modelo não é concluído.
ModelDeprecated	Modelo preterido.
ModelExists	O modelo existe.
ModelMismatch	Incompatibilidade de modelo.
ModelNotDeployable	Modelo não implantável.
ModelVersionIncorrect	Versão do modelo incorreta.
NoUtf8WithBom	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	Apenas uma das URLs, contêiner ou conjunto de dados.
ProjectGenderMismatch	Incompatibilidade de gênero do projeto.
QuotaViolation	Violação de cota.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
SkuLimitsExist	Existem limites de SKU.
SubscriptionNotFound	Assinatura não encontrada.
UnexpectedError	Erro inesperado.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
UnsupportedDelta	Delta sem suporte.
UnsupportedDynamicConfiguration	Configuração dinâmica sem suporte.
UnsupportedFilter	Filtro sem suporte.
UnsupportedLanguageCode	Código de linguagem sem suporte.
UnsupportedOrderBy	Ordem sem suporte por.
UnsupportedPagination	Paginação sem suporte.
UnsupportedTimeRange	Intervalo de tempo sem suporte.

DiarizationProperties

Objeto

DiarizationProperties

Nome	Tipo	Description
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Objeto

DiarizationSpeakersProperties

Nome	Tipo	Description
maxCount	integer (int32) minimum: 1	O número máximo de alto-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 alto-falantes para diarização. Deve ser menor ou igual à propriedade maxSpeakers.

EntityError

Objeto

EntityError

Nome	Tipo	Description
code	string	O código desse erro.
message	string	A mensagem para esse erro.

EntityReference

Objeto

EntityReference

Nome	Tipo	Description
self	string (uri)	O local da entidade referenciada.

Error

Objeto

Erro

Nome	Tipo	Description
code	ErrorCode	ErrorCode Códigos de erro de alto nível.
details	Error[]	Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de erro interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

ErrorCode

Enumeração

ErrorCode

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

InnerError

Objeto

InnerError

Nome	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enumeração de código de erro detalhada.
details	object	Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos Serviços Cognitivos que está disponível em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Ele contém as propriedades obrigatórias ErrorCode e message, bem como as propriedades opcionais target, details (par chave-valor) e inner error (pode ser aninhada).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido.

LanguageIdentificationMode

Enumeração

LanguageIdentificationMode

Valor	Description
Continuous	Identificação contínua de idioma (padrão).
Single	Identificação de idioma único.

LanguageIdentificationProperties

Objeto

LanguageIdentificationProperties

Nome	Tipo	Valor padrão	Description
candidateLocales	string[]		As localidades candidatas para identificação de idioma (exemplo ["en-US", "de-DE", "es-ES"]). Há suporte para um mínimo de dois e um máximo de 10 localidades candidatas, incluindo a localidade principal para a transcrição.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode O modo usado para identificação de idioma.
speechModelMapping	<string, EntityReference>		Um mapeamento opcional de localidades para entidades de modelo de fala. Se nenhum modelo for dado 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 respectivas localidades.

ProfanityFilterMode

Enumeração

ProfanityFilterMode

Valor	Description
Masked	Mascarar o palavrão com * exceto da primeira letra, por exemplo, f***
None	Desabilite a filtragem de palavrões.
Removed	Remova o palavrão.
Tags	Adicionar marcas< XML "profanity" /Profanity>

PunctuationMode

Enumeração

PunctuationMode

Valor	Description
Automatic	Pontuação automática.
Dictated	Pontuação ditada marca apenas, ou seja, pontuação explícita.
DictatedAndAutomatic	Marcas de pontuação ditadas ou pontuação automática.
None	Sem pontuação.

Status

Enumeração

Status

Valor	Description
Failed	A operação de execução prolongada falhou.
NotStarted	A operação de execução prolongada ainda não foi iniciada.
Running	A operação de execução prolongada está sendo processada no momento.
Succeeded	A operação de execução prolongada foi concluída com êxito.

Transcription

Objeto

Transcrição

Nome	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 tem permissão para ter um tamanho máximo de 5 GB e um número máximo de 10.000 blobs. O tamanho máximo para um blob é 2,5 GB. A SAS do contêiner deve conter permissões 'r' (leitura) e 'l' (lista). Essa propriedade não será retornada em uma resposta.
contentUrls	string[] (uri)	Uma lista de URLs de conteúdo para que os arquivos de áudio sejam transcritos. Até 1000 URLs são permitidas. Essa propriedade não será retornada em uma 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", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	As propriedades personalizadas dessa entidade. O comprimento máximo permitido da chave é de 64 caracteres, o comprimento máximo de valor permitido é de 256 caracteres e a contagem de entradas permitidas é 10.
dataset	EntityReference	EntityReference
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 em que o status atual foi inserido. O carimbo de data/hora é codificado como formato de data e hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	TranscriptionLinks
locale	string minLength: 1	A localidade dos dados contidos. Se a Identificação de Idioma for usada, essa localidade será usada para transcrever a fala para a qual nenhum idioma pôde ser detectado.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	TranscriptionProperties	TranscriptionProperties
self	string (uri)	O local dessa entidade.
status	Status	Status Descrever o estado atual da API

TranscriptionLinks

Objeto

TranscriptionLinks

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

TranscriptionProperties

Objeto

TranscriptionProperties

Nome	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. Comentários 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, pois nenhuma permissão de exclusão é necessária para esse contêiner. Para dar suporte à limpeza automática, configure os tempos de vida do blob no contêiner ou use "Traga seu próprio armazenamento (BYOS)" em vez de `destinationContainerUrl`, em que os blobs podem ser limpos.
diarization	DiarizationProperties	DiarizationProperties
diarizationEnabled	boolean	Um valor que indica se a diarização (identificação do locutor) é solicitada. O valor padrão é `false`. Se esse campo for definido como true e o sistema de diarização aprimorado for configurado especificando `DiarizationProperties`, o sistema de diarização aprimorado fornecerá diarização para um intervalo configurável de alto-falantes. Se esse campo for definido como true e o sistema de diarização aprimorado não estiver habilitado (sem especificar `DiarizationProperties`), o sistema de diarização básico distinguirá entre até dois alto-falantes. Não são aplicados encargos adicionais para a diarização básica. O sistema de diarização básico foi preterido e será removido na próxima versão principal da API. Essa `diarizationEnabled` configuração também será removida.
displayFormWordLevelTimestampsEnabled	boolean	Um valor que indica se os carimbos de data/hora de nível de palavra para o formulário de exibição são solicitados. O valor padrão é `false`.
duration	string	A duração da transcrição. A duração é codificada como duração ISO 8601 ("PnYnMnDTnHnMnS", consulte https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	O endereço de email para o qual enviar notificações por email caso a operação seja concluída. O valor será removido depois de enviar o email com êxito.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Modo de filtragem de conteúdo ofensivo.
punctuationMode	PunctuationMode	PunctuationMode O modo usado para pontuação.
timeToLive	string	Por quanto tempo a transcrição será mantida no sistema após a conclusão. Depois que a transcrição atingir o tempo de vida após a conclusão (bem-sucedida ou com falha), ela será excluída automaticamente. Não definir esse valor ou defini-lo como 0 desabilitará a exclusão automática. A duração mais longa com suporte é de 31 dias. A duração é codificada como duração ISO 8601 ("PnYnMnDTnHnMnS", consulte 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 padrão é `false`.

TranscriptionUpdate

Objeto

TranscriptionUpdate

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

Compartilhar via

Transcriptions - Update

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Update a transcription

Solicitação de exemplo

Resposta de exemplo

Definições

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Comentários

TranscriptionUpdate

Recursos adicionais