Projects - List Transcriptions

Referência

Serviço:: Azure AI Services

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

Obtém a lista de transcrições para o projeto especificado.

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

Com parâmetros opcionais:

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/transcriptions?skip={skip}&top={top}&filter={filter}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	O identificador do projeto.
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 após ignorar.

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 conta dos serviços cognitivos aqui.

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT devolvido pelo STS desta região. Certifique-se de que adiciona o âmbito de gestão ao token ao adicionar a seguinte cadeia de consulta ao URL de STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Get all transcriptions

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Resposta da amostra

Código de estado:: 200

{
  "values": [
    {
      "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"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions/ba7ea6f5-3065-40b7-b49a-a90f48584683",
      "contentUrls": [
        "https://contoso.com/",
        "https://contoso2.com/"
      ],
      "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": true,
        "channels": [
          0,
          1
        ],
        "punctuationMode": "DictatedAndAutomatic",
        "profanityFilterMode": "Masked",
        "duration": "PT42S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Failed",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Transcription using adapted model en-US",
      "customProperties": {
        "key": "value"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/transcriptions?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Definições

Name	Description
DetailedErrorCode	DetailedErrorCode
DiarizationProperties	DiarizationProperties
DiarizationSpeakersProperties	DiarizationSpeakersProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Erro
ErrorCode	CódigoDoErro
InnerError	InnerError
LanguageIdentificationMode	LanguageIdentificationMode
LanguageIdentificationProperties	LanguageIdentificationProperties
PaginatedTranscriptions	PaginatedTranscriptions
ProfanityFilterMode	ProfanityFilterMode
PunctuationMode	PontuaçãoMode
Status	Estado
Transcription	Transcrição
TranscriptionLinks	TranscriptionLinks
TranscriptionProperties	TranscriptionProperties

DetailedErrorCode

Name	Tipo	Description
DataImportFailed	string	Falha na importação de dados.
DeleteNotAllowed	string	A eliminação não é permitida.
DeployNotAllowed	string	A implementação não é permitida.
DeployingFailedModel	string	A implementar o modelo com falhas.
EmptyRequest	string	Pedido Vazio.
EndpointCannotBeDefault	string	O ponto final não pode ser predefinido.
EndpointNotUpdatable	string	Ponto final não atualizável.
EndpointWithoutLogging	string	Ponto final sem registo.
ExceededNumberOfRecordingsUris	string	Número excedido de uris de gravações.
FailedDataset	string	Conjunto de dados com falha.
Forbidden	string	Proibido.
InUseViolation	string	Violação de utilização.
InaccessibleCustomerStorage	string	Armazenamento inacessível do cliente.
InvalidAdaptationMapping	string	Mapeamento de adaptação inválido.
InvalidBaseModel	string	Modelo base inválido.
InvalidCallbackUri	string	URI de chamada de retorno inválido.
InvalidCollection	string	Coleção inválida.
InvalidDataset	string	Conjunto de dados inválido.
InvalidDocument	string	Documento inválido.
InvalidDocumentBatch	string	Lote de Documento inválido.
InvalidLocale	string	Região inválida.
InvalidLogDate	string	Data de registo inválida.
InvalidLogEndTime	string	Hora de fim de registo inválida.
InvalidLogId	string	ID de registo inválido.
InvalidLogStartTime	string	Hora de início de registo 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	Payload inválido.
InvalidPermissions	string	Permissões inválidas.
InvalidPrerequisite	string	Pré-requisito inválido.
InvalidProductId	string	ID de produto inválido.
InvalidProject	string	Projeto inválido.
InvalidProjectKind	string	Tipo de projeto inválido.
InvalidRecordingsUri	string	URI de gravações inválido.
InvalidRequestBodyFormat	string	Formato de corpo do pedido inválido.
InvalidSasValidityDuration	string	Duração de validade sas inválida.
InvalidSkipTokenForLogs	string	Token de ignorar inválido para registos.
InvalidSourceAzureResourceId	string	ID de recurso do Azure de origem inválido.
InvalidSubscription	string	Subscrição inválida.
InvalidTest	string	Teste inválido.
InvalidTimeToLive	string	Tempo de vida inválido.
InvalidTopForLogs	string	Top inválido para registos.
InvalidTranscription	string	Transcrição inválida.
InvalidWebHookEventKind	string	Tipo de evento de web hook inválido.
MissingInputRecords	string	Registos de Entrada em Falta.
ModelCopyOperationExists	string	A operação de cópia de modelo existe.
ModelDeploymentNotCompleteState	string	A implementação do modelo não está concluída.
ModelDeprecated	string	Modelo preterido.
ModelExists	string	O modelo existe.
ModelMismatch	string	Erro de correspondência do modelo.
ModelNotDeployable	string	Modelo não implementável.
ModelVersionIncorrect	string	Versão do Modelo Incorreta.
NoUtf8WithBom	string	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Apenas um dos URLs, contentor ou conjunto de dados.
ProjectGenderMismatch	string	Erro de correspondência de género do projeto.
QuotaViolation	string	Violação de quota.
SingleDefaultEndpoint	string	Ponto final predefinido único.
SkuLimitsExist	string	Existem limites de SKU.
SubscriptionNotFound	string	Subscrição não encontrada.
UnexpectedError	string	Erro inesperado.
UnsupportedClassBasedAdaptation	string	Adaptação baseada em classes não suportada.
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	Encomenda não suportada por.
UnsupportedPagination	string	Paginação não suportada.
UnsupportedTimeRange	string	Intervalo de tempo não suportado.

DiarizationProperties

Name	Tipo	Description
speakers	DiarizationSpeakersProperties	DiarizationSpeakersProperties

DiarizationSpeakersProperties

Name	Tipo	Description
maxCount	integer	O número máximo de altifalantes para a diarização. Tem de ser inferior a 36 e maior ou igual à propriedade minSpeakers.
minCount	integer	Uma sugestão para o número mínimo de altifalantes para a diarização. Tem de ser menor ou igual à propriedade maxSpeakers.

EntityError

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

EntityReference

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

Error

Erro

Name	Tipo	Description
code	ErrorCode	CódigoDoErro Códigos de erro de alto nível.
details	Error[]	Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API dos Serviços Cognitivos que estão disponíveis em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Esta ação contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores de chave), erro interno (isto 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" em caso de documento inválido.

ErrorCode

CódigoDoErro

Name	Tipo	Description
Conflict	string	Representando o código de erro de conflito.
Forbidden	string	Representando o código de erro proibido.
InternalCommunicationFailed	string	A representação do código de erro de comunicação interna falhou.
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 pedido inválido.
NotAllowed	string	Representando o código de erro não permitido.
NotFound	string	Representa 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 demasiados pedidos.
Unauthorized	string	Representa o código de erro não autorizado.
UnprocessableEntity	string	Representando o código de erro de entidade não processado.
UnsupportedMediaType	string	Representando o código de erro de tipo de suporte de dados não suportado.

InnerError

Name	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enum de código de erro detalhado.
details	object	Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API dos Serviços Cognitivos que estão disponíveis em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Esta ação contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores de chave), erro interno (isto 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" em caso de documento inválido.

LanguageIdentificationMode

Name	Tipo	Description
Continuous	string	Identificação de idioma contínua (Predefinição).
Single	string	Identificação de idioma único.

LanguageIdentificationProperties

Name	Tipo	Default value	Description
candidateLocales	string[]		As regiões candidatas à identificação de idiomas (por exemplo, ["en-US", "de-DE", "es-ES"]). É suportado um mínimo de 2 e um máximo de 10 regiões candidatas, incluindo a região principal da transcrição.
mode	LanguageIdentificationMode	Continuous	LanguageIdentificationMode O modo utilizado para identificação de idiomas.
speechModelMapping	<string, EntityReference>		Um mapeamento opcional de regiões para entidades de modelo de voz. Se não for fornecido nenhum modelo para uma região, é utilizado o modelo base predefinido. As chaves têm de ser regiões contidas nas regiões candidatas, os valores são entidades para modelos das respetivas regiões.

PaginatedTranscriptions

Name	Tipo	Description
@nextLink	string	Uma ligação para o próximo conjunto de resultados paginados se existirem mais entidades disponíveis; caso contrário, nulo.
values	Transcription[]	Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou os respetivos valores predefinidos. Ao iterar através de uma lista através da paginação e eliminação de entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendado criar uma lista no cliente e eliminar após a obtenção da lista completa.

Name

Tipo

Description

@nextLink

string

Uma ligação para o próximo conjunto de resultados paginados se existirem mais entidades disponíveis; caso contrário, nulo.

values

Transcription[]

Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou os respetivos valores predefinidos.

Ao iterar através de uma lista através da paginação e eliminação de entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendado criar uma lista no cliente e eliminar após a obtenção da lista completa.

ProfanityFilterMode

Name	Tipo	Description
Masked	string	Mascarar a profanidade com * exceto a primeira letra, por exemplo, f***
None	string	Desative a filtragem de palavras ofensivas.
Removed	string	Remover palavras ofensivas.
Tags	string	Adicionar etiquetas< XML "profanity" /Profanity>

PunctuationMode

PontuaçãoMode

Name	Tipo	Description
Automatic	string	Pontuação automática.
Dictated	string	Pontuação ditada apenas, ou seja, pontuação explícita.
DictatedAndAutomatic	string	Pontuação ditada ou pontuação automática.
None	string	Sem pontuação.

Status

Estado

Name	Tipo	Description
Failed	string	A operação de execução prolongada falhou.
NotStarted	string	A operação de execução prolongada ainda não foi iniciada.
Running	string	A operação de execução prolongada está atualmente a ser processada.
Succeeded	string	A operação de execução prolongada foi concluída com êxito.

Transcription

Transcrição

Name	Tipo	Description
contentContainerUrl	string	Um URL para um contentor de blobs do Azure que contém os ficheiros de áudio. Um contentor tem permissão para 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. As SAS de Contentor devem conter permissões "r" (leitura) e "l" (lista). Esta propriedade não será devolvida numa resposta.
contentUrls	string[]	Uma lista de urls de conteúdo para obter ficheiros de áudio para transcrever. São permitidos até 1000 urls. Esta propriedade não será devolvida numa resposta.
createdDateTime	string	O carimbo de data/hora quando o objeto foi criado. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte 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 carateres, o comprimento máximo permitido do valor é de 256 carateres e a contagem de entradas permitidas é de 10.
dataset	EntityReference	EntityReference
description	string	A descrição do objeto.
displayName	string	O nome a apresentar do objeto.
lastActionDateTime	string	O carimbo de data/hora quando o estado atual foi introduzido. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	TranscriptionLinks	TranscriptionLinks
locale	string	A região dos dados contidos. Se a Identificação de Idioma for utilizada, esta região é utilizada para transcrever voz para a qual não foi possível detetar nenhum idioma.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	TranscriptionProperties	TranscriptionProperties
self	string	A localização desta entidade.
status	Status	Estado Descrever o estado atual da API

TranscriptionLinks

Name	Tipo	Description
files	string	A localização para obter todos os ficheiros desta entidade. Veja a operação "Transcriptions_ListFiles" para obter mais detalhes.

TranscriptionProperties

Name	Tipo	Description
channels	integer[]	Uma coleção dos números de canal pedidos. No caso predefinido, os canais 0 e 1 são considerados.
destinationContainerUrl	string	O contentor de destino pedido. Observações Quando um contentor de destino é utilizado em combinação com um `timeToLive`, os metadados de uma transcrição serão eliminados normalmente, mas os dados armazenados no contentor de destino, incluindo os resultados da transcrição, permanecerão inalterados, uma vez que não são necessárias permissões de eliminação para este contentor. Para suportar a limpeza automática, configure durações de blobs no contentor ou utilize "Traga o seu próprio Armazenamento (BYOS)" em vez de `destinationContainerUrl`, onde os blobs podem ser limpos.
diarization	DiarizationProperties	DiarizationProperties
diarizationEnabled	boolean	Um valor que indica se é pedida a diarização (identificação de orador). O valor predefinido é `false`. Se este campo estiver definido como verdadeiro e o sistema de diarização melhorado estiver configurado ao especificar `DiarizationProperties`, o sistema de diarização melhorado fornecerá a diarização para um intervalo configurável de altifalantes. Se este campo estiver definido como verdadeiro e o sistema de diarização melhorado não estiver ativado (não especificando `DiarizationProperties`), o sistema de diarização básico irá distinguir entre até dois altifalantes. Não são aplicados custos 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. Esta `diarizationEnabled` definição também será removida.
displayFormWordLevelTimestampsEnabled	boolean	Um valor que indica se são pedidos carimbos de data/hora ao nível da palavra para o formulário de apresentação. O valor predefinido é `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 e-mail para o qual enviar notificações por e-mail, caso a operação seja concluída. O valor será removido depois de enviar o e-mail com êxito.
error	EntityError	EntityError
languageIdentification	LanguageIdentificationProperties	LanguageIdentificationProperties
profanityFilterMode	ProfanityFilterMode	ProfanityFilterMode Modo de filtragem de palavrões.
punctuationMode	PunctuationMode	PontuaçãoMode O modo utilizado para pontuação.
timeToLive	string	Durante quanto tempo a transcrição será mantida no sistema depois de concluída. Assim que a transcrição atingir o tempo de vida após a conclusão (com êxito ou com falha), esta será automaticamente eliminada. Não definir este valor ou defini-lo como 0 irá desativar a eliminação automática. A duração suportada mais longa é 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 são pedidos carimbos de data/hora ao nível da palavra. O valor predefinido é `false`.

Partilhar via

Projects - List Transcriptions

Parâmetros do URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Get all transcriptions

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

DiarizationProperties

DiarizationSpeakersProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

LanguageIdentificationMode

LanguageIdentificationProperties

PaginatedTranscriptions

ProfanityFilterMode

PunctuationMode

Status

Transcription

TranscriptionLinks

TranscriptionProperties

Observações

Recursos adicionais