Models - List Base Models

Serviço:: Azure AI Services

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

Obtém a lista de modelos base para a assinatura autenticada.

GET {endpoint}/speechtotext/v3.2-preview.2/models/base

Com parâmetros opcionais:

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip={skip}&top={top}&filter={filter}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string	Pontos de extremidade dos Serviços Cognitivos com suporte (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 modelos base 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=status eq 'NotStarted' or status eq 'Running'`
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

Nome	Tipo	Description
200 OK	PaginatedBaseModels	OKEY
Other Status Codes	Error	Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da 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. Adicione o escopo de gerenciamento ao token adicionando a seguinte cadeia de caracteres de consulta à URL do STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Get all english base models

Solicitação de exemplo

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip=0&top=2&filter=locale%20eq%20'en-US'

Resposta de exemplo

Código de status:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
      },
      "properties": {
        "deprecationDates": {
          "adaptationDateTime": "2022-11-04T00:00:00Z",
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": true,
          "supportsAdaptationsWith": [
            "Language",
            "Acoustic"
          ],
          "supportedOutputFormats": [
            "Display",
            "Lexical"
          ]
        },
        "chargeForAdaptation": true
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "en-US Base model"
    }
  ]
}

Definições

Nome	Description
BaseModel	BaseModel
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	BaseModelLinks
BaseModelProperties	BaseModelProperties
DatasetKind	DatasetKind
DetailedErrorCode	DetailedErrorCode
Error	Erro
ErrorCode	Código de Erro
InnerError	InnerError
OutputFormatType	OutputFormatType
PaginatedBaseModels	PaginatedBaseModels
Status	Situação

BaseModel

Objeto

BaseModel

Nome	Tipo	Description
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 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
description	string	A descrição do objeto.
displayName	string minLength: 1	O nome de exibição do objeto.
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 ("YYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	BaseModelLinks	BaseModelLinks
locale	string minLength: 1	A localidade dos dados contidos.
properties	BaseModelProperties	BaseModelProperties
self	string (uri)	O local dessa entidade.
status	Status	Situação Descrever o estado atual da API

BaseModelDeprecationDates

Objeto

BaseModelDeprecationDates

Nome	Tipo	Description
adaptationDateTime	string (date-time)	A data em que a adaptação é preterida.
transcriptionDateTime	string (date-time)	A data em que a transcrição é preterida.

BaseModelFeatures

Objeto

BaseModelFeatures

Nome	Tipo	Description
supportedOutputFormats	OutputFormatType[]	Formatos de saída com suporte.
supportsAdaptationsWith	DatasetKind[]	Tipos de conjunto de dados com suporte para adaptar o modelo.
supportsEndpoints	boolean	Um valor que indica se há suporte para a criação de pontos de extremidade para transcrição dinâmica.
supportsTranscriptions	boolean	Um valor que indica se a transcrição em lote tem suporte.
supportsTranscriptionsOnSpeechContainers	boolean	Um valor que indica se esse modelo pode ser usado para transcrição no contêiner de fala. Esse recurso pode ser adicionado em modelos existentes quando ele se torna utilizável no contêiner de fala.

BaseModelLinks

Objeto

BaseModelLinks

Nome	Tipo	Description
manifest	string (uri)	O local para obter um manifesto para esse modelo a ser usado no contêiner local. Consulte a operação "Models_GetCustomModelManifest" para obter mais detalhes.

BaseModelProperties

Objeto

BaseModelProperties

Nome	Tipo	Description
chargeForAdaptation	boolean	Um valor que indica se a adaptação de modelo é cobrada.
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures Recursos compatíveis com o modelo.

DatasetKind

Enumeração

DatasetKind

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

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
InvalidParameterValue	Valor de parâmetro inválido.
InvalidRequestBodyFormat	Formato do corpo da solicitação inválido.
EmptyRequest	Solicitação vazia.
MissingInputRecords	Registros de entrada ausentes.
InvalidDocument	Documento inválido.
ModelVersionIncorrect	Versão do modelo incorreta.
InvalidDocumentBatch	Lote de Documentos Inválido.
UnsupportedLanguageCode	Código de idioma sem suporte.
DataImportFailed	Falha na importação de dados.
InUseViolation	Em violação de uso.
InvalidLocale	Localidade inválida.
InvalidBaseModel	Modelo base inválido.
InvalidAdaptationMapping	Mapeamento de adaptação inválido.
InvalidDataset	Conjunto de dados inválido.
InvalidTest	Teste inválido.
FailedDataset	Conjunto de dados com falha.
InvalidModel	Modelo inválido.
InvalidTranscription	Transcrição inválida.
InvalidPayload	Conteúdo inválido.
InvalidParameter	Parâmetro inválido.
EndpointWithoutLogging	Ponto de extremidade sem registro em log.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválido.
InvalidSubscription	Assinatura inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	URI de gravações inválido.
OnlyOneOfUrlsOrContainerOrDataset	Apenas uma das URLs, contêiner ou conjunto de dados.
ExceededNumberOfRecordingsUris	Número excedido de uris de gravações.
ModelMismatch	Incompatibilidade de modelo.
ProjectGenderMismatch	Incompatibilidade de gênero do projeto.
ModelDeprecated	Modelo preterido.
ModelExists	O modelo existe.
ModelNotDeployable	Modelo não implantável.
EndpointNotUpdatable	Ponto de extremidade não atualizável.
SingleDefaultEndpoint	Ponto de extremidade padrão único.
EndpointCannotBeDefault	O ponto de extremidade não pode ser padrão.
InvalidModelUri	URI de modelo inválido.
SubscriptionNotFound	Assinatura não encontrada.
QuotaViolation	Violação de cota.
UnsupportedDelta	Delta sem suporte.
UnsupportedFilter	Filtro sem suporte.
UnsupportedPagination	Paginação sem suporte.
UnsupportedDynamicConfiguration	Configuração dinâmica sem suporte.
UnsupportedOrderBy	Ordem sem suporte por.
NoUtf8WithBom	Não utf8 com bom.
ModelDeploymentNotCompleteState	Implantação de modelo não completa o estado.
SkuLimitsExist	Existem limites de SKU.
DeployingFailedModel	Implantação de modelo com falha.
UnsupportedTimeRange	Intervalo de tempo sem suporte.
InvalidLogDate	Data de log inválida.
InvalidLogId	ID de log inválida.
InvalidLogStartTime	Hora de início do log inválida.
InvalidLogEndTime	Hora de término do log inválida.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidSkipTokenForLogs	Token de ignorar inválido para logs.
DeleteNotAllowed	Exclusão não permitida.
Forbidden	Proibido.
DeployNotAllowed	Implantação não permitida.
UnexpectedError	Erro inesperado.
InvalidCollection	Coleção inválida.
InvalidCallbackUri	URI de retorno de chamada inválido.
InvalidSasValidityDuration	Duração de validade sas inválida.
InaccessibleCustomerStorage	Armazenamento de clientes inacessível.
UnsupportedClassBasedAdaptation	Adaptação baseada em classe sem suporte.
InvalidWebHookEventKind	Tipo de evento de gancho da Web inválido.
InvalidTimeToLive	Tempo de vida inválido.
InvalidSourceAzureResourceId	ID de recurso do Azure de origem inválida.
ModelCopyOperationExists	A operação de cópia de modelo existe.

Error

Objeto

Erro

Nome	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 as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos 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, destino de mensagens e propriedades opcionais, detalhes (par de valor 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, seriam "documentos" ou "id de documento" em caso de documento inválido.

ErrorCode

Enumeração

Código de Erro

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

InnerError

Objeto

InnerError

Nome	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enumeração detalhada do código de erro.
details	object	Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes de API dos 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, destino de mensagens e propriedades opcionais, detalhes (par de valor 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, seriam "documentos" ou "id de documento" em caso de documento inválido.

OutputFormatType

Enumeração

OutputFormatType

Valor	Description
Lexical	O modelo fornece a saída de transcrição sem formatação.
Display	O modelo dá suporte à exibição de saída ou pontos de extremidade de transcrições de formatação.

PaginatedBaseModels

Objeto

PaginatedBaseModels

Nome	Tipo	Description
@nextLink	string (uri)	Um link para o próximo conjunto de resultados paginados se houver mais entidades disponíveis; caso contrário, nulo.
values	BaseModel[]	Uma lista de entidades limitada pelos parâmetros de consulta passados 'skip' e 'top' ou seus valores padrão. Ao iterar por meio de uma lista usando paginação e excluindo entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendável criar uma lista no cliente e excluir após a busca da lista completa.

Nome

Tipo

Description

@nextLink

string (uri)

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

values

BaseModel[]

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

Ao iterar por meio de uma lista usando paginação e excluindo entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendável criar uma lista no cliente e excluir após a busca da lista completa.

Status

Enumeração

Situação

Valor	Description
NotStarted	A operação de execução prolongada ainda não foi iniciada.
Running	A operação de execução longa está sendo processada no momento.
Succeeded	A operação de execução longa foi concluída com êxito.
Failed	A operação de execução prolongada falhou.