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

Name	Tipo	Description
200 OK	PaginatedBaseModels	OK
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 english base models

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 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

Name	Description
BaseModel	Modelo Base
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

Object

Modelo Base

Name	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 ("AAAA-MM-DDThh:mm:ssZ", ver 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 para 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 ("AAAA-MM-DDThh:mm:ssZ", ver 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)	A localização desta entidade.
status	Status	Situação Descrever o estado atual da API

BaseModelDeprecationDates

Object

BaseModelDeprecationDates

Name	Tipo	Description
adaptationDateTime	string (date-time)	A data em que a adaptação se torna obsoleta.
transcriptionDateTime	string (date-time)	A data em que a transcrição se torna obsoleta.

BaseModelFeatures

Object

BaseModelFeatures

Name	Tipo	Description
supportedOutputFormats	OutputFormatType[]	Formatos de saída suportados.
supportsAdaptationsWith	DatasetKind[]	Tipos de conjunto de dados suportados para adaptar o modelo.
supportsEndpoints	boolean	Um valor que indica se a criação de pontos de extremidade para transcrição ao vivo é suportada.
supportsTranscriptions	boolean	Um valor que indica se a transcrição em lote é suportada.
supportsTranscriptionsOnSpeechContainers	boolean	Um valor que indica se este modelo pode ser usado para transcrição no recipiente de fala. Esse recurso pode ser adicionado em modelos existentes quando se torna utilizável no contêiner de fala.

BaseModelLinks

Object

BaseModelLinks

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

BaseModelProperties

Object

BaseModelProperties

Name	Tipo	Description
chargeForAdaptation	boolean	Um valor que indica se a adaptação do modelo é cobrada.
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures Recursos suportados pelo modelo.

DatasetKind

Enumeração

DatasetKind

Valor	Description
Language	Um conjunto de dados de idioma.
Acoustic	Um conjunto de dados acústicos.
Pronunciation	Um conjunto de dados de pronúncia.
AudioFiles	Um conjunto de dados de arquivos de áudio.
LanguageMarkdown	Um conjunto de dados de marcação de idioma.
OutputFormatting	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

DetailedErrorCode

Enumeração

DetailedErrorCode

Valor	Description
InvalidParameterValue	Valor de parâmetro inválido.
InvalidRequestBodyFormat	Formato de corpo de solicitação inválido.
EmptyRequest	Pedido vazio.
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 não suportado.
DataImportFailed	Falha na importação de dados.
InUseViolation	Violação em 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	Carga útil inválida.
InvalidParameter	Parâmetro inválido.
EndpointWithoutLogging	Ponto de extremidade sem registro.
InvalidPermissions	Permissões inválidas.
InvalidPrerequisite	Pré-requisito inválido.
InvalidProductId	ID do produto inválida.
InvalidSubscription	Subscrição inválida.
InvalidProject	Projeto inválido.
InvalidProjectKind	Tipo de projeto inválido.
InvalidRecordingsUri	Gravações inválidas uri.
OnlyOneOfUrlsOrContainerOrDataset	Apenas um dos urls ou contêiner ou conjunto de dados.
ExceededNumberOfRecordingsUris	Excedeu o número de gravações uris.
ModelMismatch	Incompatibilidade de modelos.
ProjectGenderMismatch	Desfasamento entre homens e mulheres no projeto.
ModelDeprecated	Modelo preterido.
ModelExists	Modelo existe.
ModelNotDeployable	Modelo não implantável.
EndpointNotUpdatable	Ponto final 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	Subscrição não encontrada.
QuotaViolation	Violação de quotas.
UnsupportedDelta	Delta não suportado.
UnsupportedFilter	Filtro não suportado.
UnsupportedPagination	Paginação não suportada.
UnsupportedDynamicConfiguration	Configuração dinâmica não suportada.
UnsupportedOrderBy	Ordem não suportada por.
NoUtf8WithBom	Não utf8 com bom.
ModelDeploymentNotCompleteState	Implantação do modelo não concluída estado.
SkuLimitsExist	Existem limites de Sku.
DeployingFailedModel	Implantação de modelo com falha.
UnsupportedTimeRange	Intervalo de tempo não suportado.
InvalidLogDate	Data de registo inválida.
InvalidLogId	ID de log inválido.
InvalidLogStartTime	Hora de início de log inválida.
InvalidLogEndTime	Hora de fim de log inválida.
InvalidTopForLogs	Parte superior inválida para logs.
InvalidSkipTokenForLogs	Token de pulo inválido para logs.
DeleteNotAllowed	Excluir não permitido.
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 inacessível do cliente.
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 do modelo existe.

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
InvalidRequest	Representando o código de erro de solicitação inválida.
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 não suportado.
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

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.

OutputFormatType

Enumeração

OutputFormatType

Valor	Description
Lexical	Modelo fornece a saída de transcrição sem formatação.
Display	O modelo suporta formatação de exibição, transcrições, saída ou pontos de extremidade.

PaginatedBaseModels

Object

PaginatedBaseModels

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	BaseModel[]	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 (uri)

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

values

BaseModel[]

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