Transcriptions - List

Referência

Serviço:: Azure AI Services

Versão da API:: 2024-11-15

Obtém uma lista de transcrições para a assinatura autenticada.

GET {endpoint}/speechtotext/transcriptions?api-version=2024-11-15

Com parâmetros opcionais:

GET {endpoint}/speechtotext/transcriptions?skip={skip}&top={top}&filter={filter}&api-version=2024-11-15

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).
api-version	query	True	string	A versão da api solicitada.
filter	query		string	Uma expressão de filtragem para selecionar um subconjunto das transcrições disponíveis. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=createdDateTime gt 2022-02-01T11:00:00Z`
skip	query		integer int32	Número de conjuntos de dados que serão ignorados.
top	query		integer int32	Número de conjuntos de dados que serão incluídos depois de ignorar.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Ocp-Apim-Subscription-Key	True	string	Forneça a chave da sua conta de serviços cognitivos aqui.

Respostas

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

Name

Tipo

Description

200 OK

PaginatedTranscriptions

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

Exemplos

Get all failed transcriptions

Get all transcriptions

Get all failed transcriptions

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/transcriptions?skip=0&top=2&filter=status%20eq%20'Failed'&api-version=2024-11-15

Resposta da amostra

Código de estado:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      },
      "locale": "en-US",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-11-15"
      },
      "properties": {
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "timeToLiveHours": 48,
        "durationMilliseconds": 42000
      },
      "status": "Failed"
    }
  ]
}

Get all transcriptions

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/transcriptions?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15

Resposta da amostra

Código de estado:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      },
      "locale": "en-US",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-11-15"
      },
      "properties": {
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": false,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "timeToLiveHours": 48,
        "durationMilliseconds": 42000
      },
      "status": "Succeeded"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683?api-version=2024-11-15",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      },
      "locale": "en-US",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "model": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683/files?api-version=2024-11-15"
      },
      "properties": {
        "wordLevelTimestampsEnabled": false,
        "displayFormWordLevelTimestampsEnabled": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "timeToLiveHours": 48,
        "durationMilliseconds": 42000
      },
      "status": "Failed"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15"
}

Definições

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

DetailedErrorCode

Name	Tipo	Description
AudioLengthLimitExceeded	string	O arquivo de áudio é maior do que a duração máxima permitida.
BadChannelConfiguration	string	Há uma incompatibilidade entre os canais de áudio nos dados, na configuração ou nos requisitos do aplicativo.
DataImportFailed	string	Falha na importação de dados.
DeleteNotAllowed	string	Excluir não permitido.
DeployNotAllowed	string	Implantação não permitida.
DeployingFailedModel	string	Implantação de modelo com falha.
EmptyAudioFile	string	O arquivo de áudio está vazio.
EmptyRequest	string	Pedido vazio.
EndpointCannotBeDefault	string	O ponto de extremidade não pode ser padrão.
EndpointLoggingNotSupported	string	Não há suporte para registro de ponto final.
EndpointNotUpdatable	string	Ponto final não atualizável.
EndpointWithoutLogging	string	Ponto de extremidade sem registro.
ExceededNumberOfRecordingsUris	string	Excedeu o número de gravações uris.
FailedDataset	string	Conjunto de dados com falha.
Forbidden	string	Proibido.
InUseViolation	string	Violação em uso.
InaccessibleCustomerStorage	string	Armazenamento inacessível do cliente.
InvalidAdaptationMapping	string	Mapeamento de adaptação inválido.
InvalidAudioFormat	string	O formato de entrada de áudio não é suportado.
InvalidBaseModel	string	Modelo base inválido.
InvalidCallbackUri	string	Uri de retorno de chamada inválido.
InvalidChannelSpecification	string	A seleção de canais na solicitação de transcrição não é suportada (por exemplo, nem 0 nem 1 foram selecionados).
InvalidChannels	string	Canais inválidos.
InvalidCollection	string	Coleção inválida.
InvalidDataset	string	Conjunto de dados inválido.
InvalidDocument	string	Documento inválido.
InvalidDocumentBatch	string	Lote de documentos inválido.
InvalidLocale	string	Localidade inválida.
InvalidLogDate	string	Data de registo inválida.
InvalidLogEndTime	string	Hora de fim de log inválida.
InvalidLogId	string	ID de log inválido.
InvalidLogStartTime	string	Hora de início de log inválida.
InvalidModel	string	Modelo inválido.
InvalidModelUri	string	Uri de modelo inválido.
InvalidParameter	string	Parâmetro inválido.
InvalidParameterValue	string	Valor de parâmetro inválido.
InvalidPayload	string	Carga útil inválida.
InvalidPermissions	string	Permissões inválidas.
InvalidPrerequisite	string	Pré-requisito inválido.
InvalidProductId	string	ID do produto inválida.
InvalidProject	string	Projeto inválido.
InvalidProjectKind	string	Tipo de projeto inválido.
InvalidRecordingsUri	string	Gravações inválidas uri.
InvalidRequestBodyFormat	string	Formato de corpo de solicitação inválido.
InvalidSasValidityDuration	string	Duração de validade sas inválida.
InvalidSkipTokenForLogs	string	Token de pulo inválido para logs.
InvalidSourceAzureResourceId	string	ID de recurso do Azure de origem inválida.
InvalidSubscription	string	Subscrição inválida.
InvalidTest	string	Teste inválido.
InvalidTimeToLive	string	Tempo de vida inválido.
InvalidTopForLogs	string	Parte superior inválida para logs.
InvalidTranscription	string	Transcrição inválida.
InvalidWebHookEventKind	string	Tipo de evento de gancho da Web inválido.
MissingInputRecords	string	Registros de entrada ausentes.
ModelCopyAuthorizationExpired	string	ModelCopyAuthorization expirado.
ModelDeploymentNotCompleteState	string	Implantação do modelo não concluída estado.
ModelDeprecated	string	Modelo preterido.
ModelExists	string	Modelo existe.
ModelMismatch	string	Incompatibilidade de modelos.
ModelNotDeployable	string	Modelo não implantável.
ModelVersionIncorrect	string	Versão do modelo incorreta.
MultipleLanguagesIdentified	string	A Identificação Linguística reconheceu vários idiomas. Nenhuma língua dominante pôde ser determinada.
NoLanguageIdentified	string	A Identificação Linguística não reconhecia nenhuma língua.
NoUtf8WithBom	string	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Apenas um dos urls ou contêiner ou conjunto de dados.
ProjectGenderMismatch	string	Desfasamento entre homens e mulheres no projeto.
QuotaViolation	string	Violação de quotas.
SingleDefaultEndpoint	string	Ponto de extremidade padrão único.
SkuLimitsExist	string	Existem limites de Sku.
SubscriptionNotFound	string	Subscrição não encontrada.
UnexpectedError	string	Erro inesperado.
UnsupportedClassBasedAdaptation	string	Adaptação baseada em classe sem suporte.
UnsupportedDelta	string	Delta não suportado.
UnsupportedDynamicConfiguration	string	Configuração dinâmica não suportada.
UnsupportedFilter	string	Filtro não suportado.
UnsupportedLanguageCode	string	Código de idioma não suportado.
UnsupportedOrderBy	string	Ordem não suportada por.
UnsupportedPagination	string	Paginação não suportada.
UnsupportedTimeRange	string	Intervalo de tempo não suportado.

DiarizationProperties

DiarizaçãoPropriedades

Name	Tipo	Description
enabled	boolean	Um valor que indica se a diarização do alto-falante está habilitada.
maxSpeakers	integer	Uma dica para o número máximo de falantes para diarização. Deve ser maior que 1 e menor que 36.

EntityError

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

EntityReference

EntidadeReferência

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

Error

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

Código de erro

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

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

Name	Tipo	Description
Continuous	string	Identificação contínua do idioma (padrão).
Single	string	Identificação de uma única língua. Se nenhum idioma puder ser identificado, o código de erro NoLanguageIdentified será retornado ao usuário. Se houver ambiguidade entre vários idiomas, o código de erro MultipleLanguagesIdentified é retornado para o usuário.

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 para o modo contínuo. Para identificação de idioma único, o número máximo de localidades candidatas é ilimitado.
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.

PaginatedTranscriptions

Transcrições paginadasTranscrições

Name	Tipo	Description
@nextLink	string	Um link para o próximo conjunto de resultados paginados, se houver mais entidades disponíveis; caso contrário, null.
values	Transcription[]	Uma lista de entidades limitadas pelos parâmetros de consulta passados 'skip' e 'top' ou seus valores padrão. Ao iterar através de uma lista usando paginação e excluindo entidades em paralelo, algumas entidades serão ignoradas nos resultados. Recomenda-se criar uma lista no cliente e excluir após a busca da lista completa.

Name

Tipo

Description

@nextLink

string

Um link para o próximo conjunto de resultados paginados, se houver mais entidades disponíveis; caso contrário, null.

values

Transcription[]

Uma lista de entidades limitadas pelos parâmetros de consulta passados 'skip' e 'top' ou seus valores padrão.

Ao iterar através de uma lista usando paginação e excluindo entidades em paralelo, algumas entidades serão ignoradas nos resultados. Recomenda-se criar uma lista no cliente e excluir após a busca da lista completa.

ProfanityFilterMode

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

PunctuationMode

PontuaçãoModo de Pontuação

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

Status

Situação

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

Transcription

Transcrição

Name	Tipo	Description
contentContainerUrl	string	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[]	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	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	O nome para exibição do objeto.
lastActionDateTime	string	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	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
properties	TranscriptionProperties	TranscriçãoPropriedades
self	string	A localização desta entidade.
status	Status	Situação Descreva o estado atual da API.

TranscriptionLinks

TranscriçãoLinks

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

TranscriptionProperties

TranscriçãoPropriedades

Name	Tipo	Default value	Description
channels	integer[]		Uma coleção dos números de canal solicitados. No caso padrão, os canais 0 e 1 são considerados.
destinationContainerUrl	string		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, 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
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 padrão é `false`.
durationMilliseconds	integer	0	A duração em milissegundos da transcrição. Durações maiores que 2^53-1 não são suportadas para garantir a compatibilidade com inteiros JavaScript.
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.
timeToLiveHours	integer		Por quanto tempo a transcrição será mantida no sistema após sua conclusão. Uma vez que a transcrição atinge o tempo de vida após a conclusão (bem-sucedida ou falhada), ela será automaticamente excluída. Nota: Ao usar o BYOS (traga seu próprio armazenamento), os arquivos de resultado na conta de armazenamento de propriedade do cliente também serão excluídos. Use destinationContainerUrl para especificar um contêiner separado para arquivos de resultado que não serão excluídos quando o timeToLive expirar, ou recupere os arquivos de resultado por meio da API e armazene-os conforme necessário. A duração suportada mais curta é de 6 horas, a duração suportada mais longa é de 31 dias. 2 dias (48 horas) é o valor padrão recomendado quando os dados são consumidos diretamente.
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`.

Partilhar via

Transcriptions - List

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Get all failed transcriptions

Pedido de amostra

Resposta da amostra

Get all transcriptions

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

DiarizationProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

PaginatedTranscriptions

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Comentários

Recursos adicionais