Models - List Base Models
Obtém a lista de modelos base para a assinatura autenticada.
GET {endpoint}/speechtotext/v3.2-preview.2/models/base
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.
|
|
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
Nome | Tipo | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Ocorreu um erro. |
Segurança
Ocp-Apim-Subscription-Key
Forneça sua chave de conta de serviços cognitivos aqui.
Tipo:
apiKey
Em:
header
Authorization
Forneça um token de acesso do JWT retornado pelo STS dessa 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
GET {endpoint}/speechtotext/v3.2-preview.2/models/base?skip=0&top=2&filter=locale%20eq%20'en-US'
Resposta de exemplo
{
"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 |
---|---|
Base |
BaseModel |
Base |
BaseModelDeprecationDates |
Base |
BaseModelFeatures |
Base |
BaseModelLinks |
Base |
BaseModelProperties |
Dataset |
DatasetKind |
Detailed |
DetailedErrorCode |
Error |
Erro |
Error |
ErrorCode |
Inner |
InnerError |
Output |
OutputFormatType |
Paginated |
PaginatedBaseModels |
Status |
Status |
BaseModel
BaseModel
Nome | Tipo | Description |
---|---|---|
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 ("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 |
O nome para exibição do objeto. |
lastActionDateTime |
string |
O carimbo de data/hora em que a status atual foi inserida. 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 |
|
locale |
string |
A localidade dos dados contidos. |
properties |
BaseModelProperties |
|
self |
string |
O local dessa entidade. |
status |
Status |
BaseModelDeprecationDates
BaseModelDeprecationDates
Nome | Tipo | Description |
---|---|---|
adaptationDateTime |
string |
A data em que a adaptação se torna preterida. |
transcriptionDateTime |
string |
A data em que a transcrição é preterida. |
BaseModelFeatures
BaseModelFeatures
Nome | Tipo | Description |
---|---|---|
supportedOutputFormats |
Formatos de saída com suporte. |
|
supportsAdaptationsWith |
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 há suporte para transcrição em lote. |
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
BaseModelLinks
Nome | Tipo | Description |
---|---|---|
manifest |
string |
O local para obter um manifesto para esse modelo a ser usado no contêiner local. Confira a operação "Models_GetCustomModelManifest" para obter mais detalhes. |
BaseModelProperties
BaseModelProperties
Nome | Tipo | Description |
---|---|---|
chargeForAdaptation |
boolean |
Um valor que indica se a adaptação do modelo é cobrada. |
deprecationDates |
BaseModelDeprecationDates |
|
features |
BaseModelFeatures |
DatasetKind
DatasetKind
Nome | Tipo | Description |
---|---|---|
Acoustic |
string |
Um conjunto de dados acústico. |
AudioFiles |
string |
Um conjunto de dados de arquivos de áudio. |
Language |
string |
Um conjunto de dados de linguagem. |
LanguageMarkdown |
string |
Um conjunto de dados de markdown de idioma. |
OutputFormatting |
string |
Conjunto de dados que contém regras para personalizar a normalização inversa de texto, capitalização, reformulação, profanação e também define testes para validação de conjunto de dados |
Pronunciation |
string |
Um conjunto de dados de pronúncia. |
DetailedErrorCode
DetailedErrorCode
Nome | Tipo | Description |
---|---|---|
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. |
EmptyRequest |
string |
Solicitação vazia. |
EndpointCannotBeDefault |
string |
O ponto de extremidade não pode ser padrão. |
EndpointNotUpdatable |
string |
Ponto de extremidade não atualizável. |
EndpointWithoutLogging |
string |
Ponto de extremidade sem registro em log. |
ExceededNumberOfRecordingsUris |
string |
Número excedido de uris de gravações. |
FailedDataset |
string |
Conjunto de dados com falha. |
Forbidden |
string |
Negado. |
InUseViolation |
string |
Violação de uso. |
InaccessibleCustomerStorage |
string |
Armazenamento inacessível do cliente. |
InvalidAdaptationMapping |
string |
Mapeamento de adaptação inválido. |
InvalidBaseModel |
string |
Modelo base inválido. |
InvalidCallbackUri |
string |
URI de retorno de chamada inválido. |
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 log inválida. |
InvalidLogEndTime |
string |
Hora de término do log inválida. |
InvalidLogId |
string |
ID de log inválida. |
InvalidLogStartTime |
string |
Hora de início do 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 |
Conteúdo inválido. |
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 |
URI de gravações inválidas. |
InvalidRequestBodyFormat |
string |
Formato do corpo da solicitação inválido. |
InvalidSasValidityDuration |
string |
Duração de validade sas inválida. |
InvalidSkipTokenForLogs |
string |
Token de ignorar inválido para logs. |
InvalidSourceAzureResourceId |
string |
ID de recurso do Azure de origem inválida. |
InvalidSubscription |
string |
Assinatura 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. |
ModelCopyOperationExists |
string |
A operação de cópia de modelo existe. |
ModelDeploymentNotCompleteState |
string |
O estado de implantação do modelo não é concluído. |
ModelDeprecated |
string |
Modelo preterido. |
ModelExists |
string |
O modelo existe. |
ModelMismatch |
string |
Incompatibilidade de modelo. |
ModelNotDeployable |
string |
Modelo não implantável. |
ModelVersionIncorrect |
string |
Versão do modelo incorreta. |
NoUtf8WithBom |
string |
Não utf8 com bom. |
OnlyOneOfUrlsOrContainerOrDataset |
string |
Apenas uma das URLs, contêiner ou conjunto de dados. |
ProjectGenderMismatch |
string |
Incompatibilidade de gênero do projeto. |
QuotaViolation |
string |
Violação de cota. |
SingleDefaultEndpoint |
string |
Ponto de extremidade padrão único. |
SkuLimitsExist |
string |
Existem limites de SKU. |
SubscriptionNotFound |
string |
Assinatura não encontrada. |
UnexpectedError |
string |
Erro inesperado. |
UnsupportedClassBasedAdaptation |
string |
Adaptação baseada em classe sem suporte. |
UnsupportedDelta |
string |
Delta sem suporte. |
UnsupportedDynamicConfiguration |
string |
Configuração dinâmica sem suporte. |
UnsupportedFilter |
string |
Filtro sem suporte. |
UnsupportedLanguageCode |
string |
Código de linguagem sem suporte. |
UnsupportedOrderBy |
string |
Ordem sem suporte por. |
UnsupportedPagination |
string |
Paginação sem suporte. |
UnsupportedTimeRange |
string |
Intervalo de tempo sem suporte. |
Error
Erro
Nome | Tipo | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas. |
innerError |
InnerError |
|
message |
string |
Mensagem de erro de alto nível. |
target |
string |
A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido. |
ErrorCode
ErrorCode
Nome | 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 do servidor interno. |
InvalidArgument |
string |
Representando o código de erro de argumento inválido. |
InvalidRequest |
string |
Representando o código de erro de solicitação inválido. |
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 sem suporte. |
InnerError
InnerError
Nome | Tipo | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Detalhes adicionais de suporte sobre o erro e/ou as políticas esperadas. |
innerError |
InnerError |
|
message |
string |
Mensagem de erro de alto nível. |
target |
string |
A origem do erro. Por exemplo, seria "documents" ou "document id" no caso de um documento inválido. |
OutputFormatType
OutputFormatType
Nome | Tipo | Description |
---|---|---|
Display |
string |
O modelo dá suporte à saída ou pontos de extremidade de transcrições de formatação de exibição. |
Lexical |
string |
O modelo fornece a saída de transcrição sem formatação. |
PaginatedBaseModels
PaginatedBaseModels
Nome | Tipo | Description |
---|---|---|
@nextLink |
string |
Um link para o próximo conjunto de resultados paginados se houver mais entidades disponíveis; caso contrário, nulo. |
values |
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 excluir 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
Status
Nome | Tipo | Description |
---|---|---|
Failed |
string |
Falha na operação de execução prolongada. |
NotStarted |
string |
A operação de execução prolongada ainda não foi iniciada. |
Running |
string |
A operação de execução prolongada está sendo processada no momento. |
Succeeded |
string |
A operação de execução prolongada foi concluída com êxito. |