Compartir a través de


Projects - List Models

Obtiene la lista de modelos para el proyecto especificado.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
endpoint
path True

string

Puntos de conexión de Cognitive Services admitidos (protocolo y nombre de host, por ejemplo: https://westus.api.cognitive.microsoft.com).

id
path True

string

uuid

Identificador del proyecto.

filter
query

string

Expresión de filtrado para seleccionar un subconjunto de los modelos disponibles.

        - 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 datos que se omitirán.

top
query

integer

int32

Número de conjuntos de datos que se incluirán después de omitir.

Respuestas

Nombre Tipo Description
200 OK

PaginatedCustomModels

Aceptar

Encabezados

Retry-After: integer

Other Status Codes

Error

Se produjo un error.

Seguridad

Ocp-Apim-Subscription-Key

Proporcione la clave de la cuenta de Cognitive Services aquí.

Tipo: apiKey
En: header

Authorization

Proporcione un token de acceso del JWT devuelto por el STS de esta región. Asegúrese de agregar el ámbito de administración al token agregando la siguiente cadena de consulta a la dirección URL de STS: ?scope=speechservicesmanagement.

Tipo: apiKey
En: header

Ejemplos

Get all models

Solicitud de ejemplo

GET {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models?skip=0&top=2&filter=status%20eq%20'Running'

Respuesta de muestra

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Language model",
      "description": "This is a language model"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Running",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Acoustic model",
      "description": "Example for an acoustic model"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models?skip=2&top=2&filter=status%20eq%20'Running'"
}

Definiciones

Nombre Description
CustomModel

CustomModel

CustomModelDeprecationDates

CustomModelDeprecationDates

CustomModelFeatures

CustomModelFeatures

CustomModelLinks

CustomModelLinks

CustomModelProperties

CustomModelProperties

DetailedErrorCode

DetailedErrorCode

EntityError

EntityError

EntityReference

EntityReference

Error

Error

ErrorCode

ErrorCode

InnerError

InnerError

OutputFormatType

OutputFormatType

PaginatedCustomModels

PaginatedCustomModels

Status

Estado

CustomModel

CustomModel

Nombre Tipo Description
baseModel

EntityReference

EntityReference

createdDateTime

string

Marca de tiempo cuando se creó el objeto. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

customProperties

object

Propiedades personalizadas de esta entidad. La longitud máxima permitida de la clave es de 64 caracteres, la longitud máxima permitida del valor es de 256 caracteres y el recuento de entradas permitidas es de 10.

datasets

EntityReference[]

Conjuntos de datos usados para la adaptación.

description

string

Descripción del objeto .

displayName

string

Nombre para mostrar del objeto.

lastActionDateTime

string

Marca de tiempo cuando se especificó el estado actual. La marca de tiempo se codifica como formato de fecha y hora ISO 8601 ("AAAA-MM-DDThh:mm:ssZ", vea https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

links

CustomModelLinks

CustomModelLinks

locale

string

Configuración regional de los datos contenidos.

project

EntityReference

EntityReference

properties

CustomModelProperties

CustomModelProperties

self

string

Ubicación de esta entidad.

status

Status

Estado
Describir el estado actual de la API

text

string

Texto utilizado para adaptar este modelo de lenguaje.

CustomModelDeprecationDates

CustomModelDeprecationDates

Nombre Tipo Description
transcriptionDateTime

string

Fecha en la que la transcripción queda en desuso.

CustomModelFeatures

CustomModelFeatures

Nombre Tipo Description
supportedOutputFormats

OutputFormatType[]

Formatos de salida admitidos.

supportsEndpoints

boolean

Valor que indica si se admite la creación de puntos de conexión para la transcripción en directo.

supportsTranscriptions

boolean

Valor que indica si se admite la transcripción por lotes.

supportsTranscriptionsOnSpeechContainers

boolean

Valor que indica si este modelo se puede usar para la transcripción en el contenedor de voz. Esta característica se puede agregar en los modelos existentes cuando se puede usar en el contenedor de voz.

CustomModelLinks

Nombre Tipo Description
copy

string

Ubicación de la acción de copia del modelo. Consulte la operación "Models_Copy" para obtener más detalles.

copyTo

string

Ubicación de la acción de copia del modelo obsoleto. Consulte la operación "Models_CopyTo" para obtener más detalles.

files

string

Ubicación para obtener todos los archivos de esta entidad. Consulte la operación "Models_ListFiles" para obtener más detalles.

manifest

string

Ubicación para obtener un manifiesto para este modelo que se va a usar en el contenedor local. Consulte la operación "Models_GetCustomModelManifest" para obtener más detalles.

CustomModelProperties

CustomModelProperties

Nombre Tipo Description
customModelWeightPercent

integer

Peso del modelo personalizado entre 1 (1 % modelo personalizado y modelo base del 99 %) y 100 (modelo personalizado del 100 % y modelo base del 0 %). Cuando no se establece esta propiedad, el servicio elige un valor adecuado (obtenga el modelo para recuperar el peso seleccionado). Comience sin usar esta propiedad. Si es necesario, elija un peso mayor (o menor) para aumentar (o disminuir) el impacto del modelo personalizado.

deprecationDates

CustomModelDeprecationDates

CustomModelDeprecationDates

email

string

Dirección de correo electrónico a la que se enviarán notificaciones por correo electrónico en caso de que se complete la operación. El valor se quitará después de enviar correctamente el correo electrónico.

error

EntityError

EntityError

features

CustomModelFeatures

CustomModelFeatures
Características compatibles con el modelo.

DetailedErrorCode

DetailedErrorCode

Nombre Tipo Description
DataImportFailed

string

Error en la importación de datos.

DeleteNotAllowed

string

No se permite eliminar.

DeployNotAllowed

string

No se permite la implementación.

DeployingFailedModel

string

Se ha producido un error en la implementación del modelo.

EmptyRequest

string

Solicitud vacía.

EndpointCannotBeDefault

string

El punto de conexión no puede ser predeterminado.

EndpointNotUpdatable

string

Punto de conexión no actualizable.

EndpointWithoutLogging

string

Punto de conexión sin registro.

ExceededNumberOfRecordingsUris

string

Se superó el número de URI de grabaciones.

FailedDataset

string

Conjunto de datos con errores.

Forbidden

string

Prohibido.

InUseViolation

string

En infracción de uso.

InaccessibleCustomerStorage

string

Almacenamiento de cliente inaccesible.

InvalidAdaptationMapping

string

Asignación de adaptación no válida.

InvalidBaseModel

string

Modelo base no válido.

InvalidCallbackUri

string

URI de devolución de llamada no válido.

InvalidCollection

string

Colección no válida.

InvalidDataset

string

Conjunto de datos no válido.

InvalidDocument

string

Documento no válido.

InvalidDocumentBatch

string

Lote de documentos no válido.

InvalidLocale

string

Configuración regional no válida.

InvalidLogDate

string

Fecha de registro no válida.

InvalidLogEndTime

string

Hora de finalización del registro no válida.

InvalidLogId

string

Identificador de registro no válido.

InvalidLogStartTime

string

Hora de inicio del registro no válida.

InvalidModel

string

Modelo no válido.

InvalidModelUri

string

URI de modelo no válido.

InvalidParameter

string

Parámetro no válido.

InvalidParameterValue

string

Valor de parámetro no válido.

InvalidPayload

string

Carga no válida.

InvalidPermissions

string

Permisos no válidos.

InvalidPrerequisite

string

Requisito previo no válido.

InvalidProductId

string

Id. de producto no válido.

InvalidProject

string

Proyecto no válido.

InvalidProjectKind

string

Tipo de proyecto no válido.

InvalidRecordingsUri

string

URI de grabaciones no válidas.

InvalidRequestBodyFormat

string

Formato de cuerpo de la solicitud no válido.

InvalidSasValidityDuration

string

Duración de validez de sas no válida.

InvalidSkipTokenForLogs

string

Token de omisión no válido para los registros.

InvalidSourceAzureResourceId

string

Identificador de recurso de Azure de origen no válido.

InvalidSubscription

string

Suscripción no válida.

InvalidTest

string

Prueba no válida.

InvalidTimeToLive

string

Período de vida no válido.

InvalidTopForLogs

string

Top no válido para los registros.

InvalidTranscription

string

Transcripción no válida.

InvalidWebHookEventKind

string

Tipo de evento webhook no válido.

MissingInputRecords

string

Faltan registros de entrada.

ModelCopyOperationExists

string

Existe la operación de copia del modelo.

ModelDeploymentNotCompleteState

string

La implementación del modelo no está completa.

ModelDeprecated

string

Modelo en desuso.

ModelExists

string

El modelo existe.

ModelMismatch

string

Error de coincidencia del modelo.

ModelNotDeployable

string

Modelo no implementable.

ModelVersionIncorrect

string

Versión del modelo incorrecta.

NoUtf8WithBom

string

No hay utf8 con bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Solo una de las direcciones URL, el contenedor o el conjunto de datos.

ProjectGenderMismatch

string

No coinciden los sexos del proyecto.

QuotaViolation

string

Infracción de cuota.

SingleDefaultEndpoint

string

Punto de conexión predeterminado único.

SkuLimitsExist

string

Existen límites de SKU.

SubscriptionNotFound

string

No se encontró la suscripción.

UnexpectedError

string

error inesperado.

UnsupportedClassBasedAdaptation

string

Adaptación basada en clases no admitida.

UnsupportedDelta

string

Delta no admitido.

UnsupportedDynamicConfiguration

string

Configuración dinámica no admitida.

UnsupportedFilter

string

Filtro no admitido.

UnsupportedLanguageCode

string

Código de idioma no admitido.

UnsupportedOrderBy

string

Orden no admitido por.

UnsupportedPagination

string

Paginación no admitida.

UnsupportedTimeRange

string

Intervalo de tiempo no admitido.

EntityError

EntityError

Nombre Tipo Description
code

string

Código de este error.

message

string

Mensaje de este error.

EntityReference

EntityReference

Nombre Tipo Description
self

string

Ubicación de la entidad a la que se hace referencia.

Error

Error

Nombre Tipo Description
code

ErrorCode

ErrorCode
Códigos de error de alto nivel.

details

Error[]

Detalles adicionales de apoyo relacionados con el error o las directivas esperadas.

innerError

InnerError

InnerError
Nuevo formato de error interno que se ajusta a las directrices de cognitive Services API que están disponibles en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y las propiedades opcionales, target, details (par clave-valor), innerError (se puede anidar).

message

string

Mensaje de error de alto nivel.

target

string

Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en el caso de un documento no válido.

ErrorCode

ErrorCode

Nombre Tipo Description
Conflict

string

Representa el código de error de conflicto.

Forbidden

string

Representa el código de error prohibido.

InternalCommunicationFailed

string

Representando el código de error de comunicación interna con errores.

InternalServerError

string

Representa el código de error interno del servidor.

InvalidArgument

string

Representa el código de error de argumento no válido.

InvalidRequest

string

Representa el código de error de solicitud no válido.

NotAllowed

string

Representa el código de error no permitido.

NotFound

string

Representa el código de error no encontrado.

PipelineError

string

Representa el código de error de canalización.

ServiceUnavailable

string

Representa el código de error del servicio no disponible.

TooManyRequests

string

Representa el código de error de demasiadas solicitudes.

Unauthorized

string

Representa el código de error no autorizado.

UnprocessableEntity

string

Representa el código de error de entidad no procesado.

UnsupportedMediaType

string

Representa el código de error de tipo de medio no admitido.

InnerError

InnerError

Nombre Tipo Description
code

DetailedErrorCode

DetailedErrorCode
Enumeración detallada del código de error.

details

object

Detalles adicionales de apoyo relacionados con el error o las directivas esperadas.

innerError

InnerError

InnerError
Nuevo formato de error interno que se ajusta a las directrices de cognitive Services API que están disponibles en https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Contiene las propiedades necesarias ErrorCode, message y las propiedades opcionales, target, details (par clave-valor), innerError (se puede anidar).

message

string

Mensaje de error de alto nivel.

target

string

Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en el caso de un documento no válido.

OutputFormatType

OutputFormatType

Nombre Tipo Description
Display

string

El modelo admite la visualización de la salida o los puntos de conexión de las transcripciones de formato.

Lexical

string

El modelo proporciona la salida de transcripción sin formato.

PaginatedCustomModels

PaginatedCustomModels

Nombre Tipo Description
@nextLink

string

Vínculo al siguiente conjunto de resultados paginados si hay más entidades disponibles; de lo contrario, es null.

values

CustomModel[]

Una lista de entidades limitadas por los parámetros de consulta pasados "skip" y "top" o sus valores predeterminados.

Al recorrer en iteración una lista mediante la paginación y la eliminación de entidades en paralelo, algunas entidades se omitirán en los resultados. Se recomienda compilar una lista en el cliente y eliminar después de la captura de la lista completa.

Status

Estado

Nombre Tipo Description
Failed

string

Error en la operación de larga duración.

NotStarted

string

La operación de larga duración aún no se ha iniciado.

Running

string

La operación de larga duración está procesando actualmente.

Succeeded

string

La operación de larga duración se ha completado correctamente.