Partilhar via

Datasets - List

  • Referência
Serviço:
Azure AI Services
Versão da API:
v3.1

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

GET {endpoint}/speechtotext/v3.1/datasets
Com parâmetros opcionais: 
GET {endpoint}/speechtotext/v3.1/datasets?skip={skip}&top={top}&filter={filter}

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).
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.

Respostas

Name Tipo Description
200 OK

PaginatedDatasets

OK

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

Get all acoustic datasets
Get all datasets

Get all acoustic datasets

Pedido de amostra

GET {endpoint}/speechtotext/v3.1/datasets?skip=0&top=10&filter=kind%20eq%20'Acoustic'

Resposta da amostra

Código de estado:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
      "kind": "Acoustic",
      "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "acceptedLineCount": 11,
        "rejectedLineCount": 2,
        "duration": "PT4M12S"
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic dataset"
    }
  ]
}

Get all datasets

Pedido de amostra

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

Definições

Name Description
Dataset

Conjunto de dados
DatasetKind

DatasetKind
DatasetLinks

DatasetLinks
DatasetProperties

DatasetProperties
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
EntityReference

EntidadeReferência
Error

Erro
ErrorCode

Código de erro
InnerError

InnerError
PaginatedDatasets

PaginatedDatasets
Status

Situação

Dataset

Object

Conjunto de dados

Name Tipo Description
contentUrl

string (uri)

A URL dos dados para o conjunto de dados.
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.
description

string

A descrição do objeto.
displayName

string

minLength: 1

O nome para exibição do objeto.
kind

DatasetKind

DatasetKind
Tipo de importação de dados.
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

DatasetLinks

DatasetLinks
locale

string

minLength: 1

A localidade dos dados contidos.
project

EntityReference

EntidadeReferência
properties

DatasetProperties

DatasetProperties
self

string (uri)

A localização desta entidade.
status

Status

Situação
Descrever o estado atual da API

DatasetKind

Enumeração

DatasetKind

Valor Description
Acoustic

Um conjunto de dados acústicos.
AudioFiles

Um conjunto de dados de arquivos de áudio.
Language

Um conjunto de dados de idioma.
LanguageMarkdown

Um conjunto de dados de marcação de idioma.
Pronunciation

Um conjunto de dados de pronúncia.
Object

DatasetLinks

Name Tipo Description
commitBlocks

string (uri)

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 (uri)

O local para obter todos os arquivos desta entidade. Consulte a operação "Datasets_ListFiles" para obter mais detalhes.
listBlocks

string (uri)

O local para listar os blocos já carregados dessa entidade ao carregar um conjunto de dados usando blocos. Consulte a operação "Datasets_GetDatasetBlocks" para obter mais detalhes.
uploadBlocks

string (uri)

O local para carregar blocos ao carregar um conjunto de dados usando blocos. Consulte a operação "Datasets_UploadBlock" para obter mais detalhes.

DatasetProperties

Object

DatasetProperties

Name Tipo Description
acceptedLineCount

integer (int32)

O número de linhas aceites para este conjunto de dados.
duration

string

A duração total dos conjuntos de dados, se ele contiver arquivos de áudio. 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
rejectedLineCount

integer (int32)

O número de linhas rejeitadas para este conjunto de dados.

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

Pedido vazio.
EndpointCannotBeDefault

O ponto de extremidade não pode ser padrão.
EndpointNotUpdatable

Ponto final não atualizável.
EndpointWithoutLogging

Ponto de extremidade sem registro.
ExceededNumberOfRecordingsUris

Excedeu o número de gravações uris.
FailedDataset

Conjunto de dados com falha.
Forbidden

Proibido.
InUseViolation

Violação em 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 registo inválida.
InvalidLogEndTime

Hora de fim de log inválida.
InvalidLogId

ID de log inválido.
InvalidLogStartTime

Hora de início de 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

Carga útil inválida.
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

Gravações inválidas uri.
InvalidRequestBodyFormat

Formato de corpo de solicitação inválido.
InvalidSasValidityDuration

Duração de validade sas inválida.
InvalidSkipTokenForLogs

Token de pulo inválido para logs.
InvalidSubscription

Subscrição 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 gancho da Web inválido.
MissingInputRecords

Registros de entrada ausentes.
ModelDeploymentNotCompleteState

Implantação do modelo não concluída estado.
ModelDeprecated

Modelo preterido.
ModelExists

Modelo existe.
ModelMismatch

Incompatibilidade de modelos.
ModelNotDeployable

Modelo não implantável.
ModelVersionIncorrect

Versão do modelo incorreta.
NoUtf8WithBom

Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset

Apenas um dos urls ou contêiner ou conjunto de dados.
ProjectGenderMismatch

Desfasamento entre homens e mulheres no projeto.
QuotaViolation

Violação de quotas.
SingleDefaultEndpoint

Ponto de extremidade padrão único.
SkuLimitsExist

Existem limites de Sku.
SubscriptionNotFound

Subscrição não encontrada.
UnexpectedError

Erro inesperado.
UnsupportedClassBasedAdaptation

Adaptação baseada em classe sem suporte.
UnsupportedDelta

Delta não suportado.
UnsupportedDynamicConfiguration

Configuração dinâmica não suportada.
UnsupportedFilter

Filtro não suportado.
UnsupportedLanguageCode

Código de idioma não suportado.
UnsupportedOrderBy

Ordem não suportada por.
UnsupportedPagination

Paginação não suportada.
UnsupportedTimeRange

Intervalo de tempo não suportado.

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
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álida.
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 indisponível do serviço.
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 não suportado.

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.

PaginatedDatasets

Object

PaginatedDatasets

Name Tipo Description
@nextLink

string (uri)

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

Enumeração

Situação

Valor Description
Failed

A operação de longa duração falhou.
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.