Partilhar via

Datasets - List

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

Obtém uma lista de conjuntos de dados para a subscrição autenticada.

GET {endpoint}/speechtotext/v3.2-preview.2/datasets
Com parâmetros opcionais: 
GET {endpoint}/speechtotext/v3.2-preview.2/datasets?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).
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 após 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 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 acoustic datasets
Get all datasets

Get all acoustic datasets

Pedido de amostra

GET {endpoint}/speechtotext/v3.2-preview.2/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.2-preview.2/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.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "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.2-preview.2/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.2-preview.2/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.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "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.2-preview.2/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.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c/files"
      },
      "properties": {
        "textNormalizationKind": "Default",
        "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.2-preview.2/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

EntityReference
Error

Erro
ErrorCode

CódigoDoErro
InnerError

InnerError
PaginatedDatasets

PaginatedDatasets
Status

Estado
TextNormalizationKind

TextNormalizationKind

Dataset

Object

Conjunto de dados

Name Tipo Description
contentUrl

string (uri)

O URL dos dados do 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", 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.
description

string

A descrição do objeto.
displayName

string

minLength: 1

O nome a apresentar do objeto.
kind

DatasetKind

DatasetKind
Tipo de importação de dados.
lastActionDateTime

string (date-time)

O carimbo de data/hora em que o estado atual foi introduzido. 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

DatasetLinks

DatasetLinks
locale

string

minLength: 1

A região dos dados contidos.
project

EntityReference

EntityReference
properties

DatasetProperties

DatasetProperties
self

string (uri)

A localização desta entidade.
status

Status

Estado
Descrever o estado atual da API

DatasetKind

Enumeração

DatasetKind

Valor Description
Acoustic

Um conjunto de dados acústico.
AudioFiles

Um conjunto de dados de ficheiros de áudio.
Language

Um conjunto de dados de linguagem.
LanguageMarkdown

Um conjunto de dados de markdown de linguagem.
OutputFormatting

Conjunto de dados que contém regras para personalizar a normalização inversa de texto, a capitalização, a reformulação, a profanidade e também define testes para validação de conjuntos de dados
Pronunciation

Um conjunto de dados de pronúncia.
Object

DatasetLinks

Name Tipo Description
commitBlocks

string (uri)

A localização para consolidar a lista de blocos ao carregar um conjunto de dados com blocos. Veja a operação "Datasets_CommitBlocks" para obter mais detalhes.
files

string (uri)

A localização para obter todos os ficheiros desta entidade. Veja a operação "Datasets_ListFiles" para obter mais detalhes.
listBlocks

string (uri)

A localização para listar os blocos já carregados desta entidade ao carregar um conjunto de dados com blocos. Veja a operação "Datasets_GetBlocks" para obter mais detalhes.
uploadBlocks

string (uri)

A localização para onde carregar blocos ao carregar um conjunto de dados com blocos. Veja 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 contiver ficheiros de áudio. 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
rejectedLineCount

integer (int32)

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

TextNormalizationKind

TextNormalizationKind
O tipo de normalização de texto.

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor Description
DataImportFailed

Falha na importação de dados.
DeleteNotAllowed

Eliminar não permitido.
DeployNotAllowed

A implementação não é permitida.
DeployingFailedModel

A implementação do modelo com falha.
EmptyRequest

Pedido Vazio.
EndpointCannotBeDefault

O ponto final não pode ser predefinido.
EndpointNotUpdatable

O ponto final não é atualizável.
EndpointWithoutLogging

Ponto final sem registo.
ExceededNumberOfRecordingsUris

Número excedido de uris de gravações.
FailedDataset

Conjunto de dados com falha.
Forbidden

Proibido.
InUseViolation

Violação de utilização.
InaccessibleCustomerStorage

Armazenamento de clientes inacessível.
InvalidAdaptationMapping

Mapeamento de adaptação inválido.
InvalidBaseModel

Modelo base inválido.
InvalidCallbackUri

URI de chamada de retorno inválido.
InvalidCollection

Coleção inválida.
InvalidDataset

Conjunto de dados inválido.
InvalidDocument

Documento inválido.
InvalidDocumentBatch

Lote de Documentos inválido.
InvalidLocale

Região inválida.
InvalidLogDate

Data de registo inválida.
InvalidLogEndTime

Hora de fim do registo inválida.
InvalidLogId

ID de registo inválido.
InvalidLogStartTime

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

Payload inválido.
InvalidPermissions

Permissões inválidas.
InvalidPrerequisite

Pré-requisito inválido.
InvalidProductId

ID de produto inválido.
InvalidProject

Projeto inválido.
InvalidProjectKind

Tipo de projeto inválido.
InvalidRecordingsUri

URI de gravações inválido.
InvalidRequestBodyFormat

Formato de corpo do pedido inválido.
InvalidSasValidityDuration

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

Token de ignorar inválido para registos.
InvalidSourceAzureResourceId

ID de recurso do Azure de origem inválido.
InvalidSubscription

Subscrição inválida.
InvalidTest

Teste inválido.
InvalidTimeToLive

Tempo de vida inválido.
InvalidTopForLogs

Top inválido para registos.
InvalidTranscription

Transcrição inválida.
InvalidWebHookEventKind

Tipo de evento de web hook inválido.
MissingInputRecords

Registos de Entrada em Falta.
ModelCopyOperationExists

A operação de cópia de modelo existe.
ModelDeploymentNotCompleteState

A implementação do modelo não está concluída.
ModelDeprecated

Modelo preterido.
ModelExists

O modelo existe.
ModelMismatch

Erro de correspondência do modelo.
ModelNotDeployable

Modelo não implementável.
ModelVersionIncorrect

Versão do Modelo Incorreta.
NoUtf8WithBom

Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset

Apenas um dos URLs, contentor ou conjunto de dados.
ProjectGenderMismatch

Erro de correspondência de género do projeto.
QuotaViolation

Violação de quota.
SingleDefaultEndpoint

Ponto final predefinido único.
SkuLimitsExist

Existem limites de SKU.
SubscriptionNotFound

Subscrição não encontrada.
UnexpectedError

Erro inesperado.
UnsupportedClassBasedAdaptation

Adaptação baseada em classes não suportada.
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

Encomenda 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

EntityReference

Name Tipo Description
self

string (uri)

A localização da entidade referenciada.

Error

Object

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 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. Contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores 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

Enumeração

CódigoDoErro

Valor Description
Conflict

Representa o código de erro de conflito.
Forbidden

Representa o código de erro proibido.
InternalCommunicationFailed

A representação do código de erro falha na comunicação interna.
InternalServerError

Representa o código de erro interno do servidor.
InvalidArgument

Representa o código de erro de argumento inválido.
InvalidRequest

Representa o código de erro de pedido inválido.
NotAllowed

Representa o código de erro não permitido.
NotFound

Representa o código de erro não encontrado.
PipelineError

Representa o código de erro do pipeline.
ServiceUnavailable

Representa o código de erro serviço indisponível.
TooManyRequests

Representa o código de erro demasiados pedidos.
Unauthorized

Representa o código de erro não autorizado.
UnprocessableEntity

Representa o código de erro de entidade não processada.
UnsupportedMediaType

Representa o código de erro do tipo de suporte de dados não suportado.

InnerError

Object

InnerError

Name Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeração detalhada do código de erro.
details

object

Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innerError

InnerError

InnerError
Novo formato de Erro Interno 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. Contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores 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.

PaginatedDatasets

Object

PaginatedDatasets

Name Tipo Description
@nextLink

string (uri)

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

Dataset[]

Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou pelos 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.

Status

Enumeração

Estado

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á atualmente a ser processada.
Succeeded

A operação de execução prolongada foi concluída com êxito.

TextNormalizationKind

Enumeração

TextNormalizationKind

Valor Description
Default

A normalização de texto predefinida (por exemplo, "2 a 3" é substituída por "dois a três" na en-US).
None

Não será aplicada qualquer normalização de texto ao texto de entrada. Esta é uma opção de substituição que só deve ser utilizada quando o texto é normalizado antes do carregamento.