Datasets - List

Referência

Serviço:: Azure AI Services

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

Obtém uma lista de conjuntos de dados para a assinatura autenticada.

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

Com parâmetros opcionais:

GET {endpoint}/speechtotext/datasets?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 dos conjuntos de dados disponíveis. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind. - 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 and displayName eq 'My dataset'`
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	PaginatedDatasets	OK Cabeçalhos Retry-After: integer
Other Status Codes	Error	Ocorreu um erro.

Name

Tipo

Description

200 OK

PaginatedDatasets

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 acoustic datasets

Get all datasets

Get all acoustic datasets

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/datasets?skip=0&top=10&filter=kind%20eq%20'Acoustic'&api-version=2024-11-15

Resposta da amostra

Código de estado:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-11-15",
      "displayName": "Acoustic dataset",
      "locale": "en-US",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "kind": "Acoustic",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-11-15"
      },
      "properties": {
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "durationMilliseconds": 252000,
        "textNormalizationKind": "Default"
      },
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "status": "Succeeded"
    }
  ]
}

Get all datasets

Pedido de amostra

HTTP

GET {endpoint}/speechtotext/datasets?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/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1?api-version=2024-11-15",
      "displayName": "Acoustic dataset",
      "locale": "en-US",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "kind": "Acoustic",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files?api-version=2024-11-15"
      },
      "properties": {
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "durationMilliseconds": 252000,
        "textNormalizationKind": "Default"
      },
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "status": "Succeeded"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-11-15",
      "displayName": "Language dataset",
      "locale": "en-US",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "kind": "Language",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files?api-version=2024-11-15"
      },
      "properties": {
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "durationMilliseconds": 0,
        "textNormalizationKind": "Default"
      },
      "contentUrl": "https://www.contoso.com/LanguageData/SourceLocation",
      "status": "Succeeded"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15"
}

Definições

Name	Description
Dataset	Conjunto de dados
DatasetKind	DatasetKind
DatasetLinks	DatasetLinks
DatasetProperties	DatasetProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Erro
ErrorCode	Código de erro
InnerError	InnerError
PaginatedDatasets	PaginatedDatasets
Status	Situação
TextNormalizationKind	TextNormalizationKind

Dataset

Conjunto de dados

Name	Tipo	Description
contentUrl	string	A URL dos dados para o conjunto de dados.
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.
description	string	A descrição do objeto.
displayName	string	O nome para exibição do objeto.
kind	DatasetKind	DatasetKind Tipo de importação de dados.
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	DatasetLinks	DatasetLinks
locale	string	A localidade dos dados contidos.
properties	DatasetProperties	DatasetProperties
self	string	A localização desta entidade.
status	Status	Situação Descreva o estado atual da API.

DatasetKind

Name	Tipo	Description
Acoustic	string	Um conjunto de dados acústicos.
AudioFiles	string	Um conjunto de dados de arquivos de áudio.
Language	string	Um conjunto de dados de idioma.
LanguageMarkdown	string	Um conjunto de dados de marcação de idioma.
OutputFormatting	string	Conjunto de dados que contém regras para personalizar a normalização de texto inverso, capitalização, reformulação, palavrões e também define testes para validação de conjunto de dados
Pronunciation	string	Um conjunto de dados de pronúncia.

DatasetLinks

Name	Tipo	Description
commitBlocks	string	O local para confirmar a lista de blocos ao carregar um conjunto de dados usando blocos. Consulte a operação "Datasets_CommitBlocks" para obter mais detalhes.
files	string	O local para obter todos os arquivos desta entidade. Consulte a operação "Datasets_ListFiles" para obter mais detalhes.
listBlocks	string	O local para listar os blocos já carregados dessa entidade ao carregar um conjunto de dados usando blocos. Consulte a operação "Datasets_GetBlocks" para obter mais detalhes.
uploadBlocks	string	O local para carregar blocos ao carregar um conjunto de dados usando blocos. Consulte a operação "Datasets_UploadBlock" para obter mais detalhes.

DatasetProperties

Name	Tipo	Default value	Description
acceptedLineCount	integer		O número de linhas aceites para este conjunto de dados.
durationMilliseconds	integer	0	A duração total em milissegundos dos conjuntos de dados, se ele contiver arquivos de áudio. Durações maiores que 2^53-1 não são suportadas para garantir a compatibilidade com inteiros JavaScript.
error	EntityError		EntityError
rejectedLineCount	integer		O número de linhas rejeitadas para este conjunto de dados.
textNormalizationKind	TextNormalizationKind		TextNormalizationKind O tipo de normalização de texto.

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.

EntityError

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

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.

PaginatedDatasets

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	Dataset[]	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

Dataset[]

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.

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.

TextNormalizationKind

Name	Tipo	Description
Default	string	Normalização do texto por defeito (por exemplo, «2 a 3» é substituído por «dois a três» na en-US).
None	string	Nenhuma normalização de texto será aplicada ao texto de entrada. Esta é uma opção de substituição que só deve ser usada quando o texto é normalizado antes do upload.

Partilhar via

Datasets - List

Parâmetros do URI

Cabeçalho do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

Exemplos

Get all acoustic datasets

Pedido de amostra

Resposta da amostra

Get all datasets

Pedido de amostra

Resposta da amostra

Definições

Dataset

DatasetKind

DatasetLinks

DatasetProperties

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

PaginatedDatasets

Status

TextNormalizationKind

Recursos adicionais