Projects - List
Obtiene la lista de proyectos de la suscripción autenticada.
GET {endpoint}/speechtotext/v3.2-preview.2/projects
GET {endpoint}/speechtotext/v3.2-preview.2/projects?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). |
filter
|
query |
string |
Expresión de filtrado para seleccionar un subconjunto de los proyectos disponibles.
|
|
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 |
De acuerdo |
|
Other Status Codes |
Se ha producido un error. |
Seguridad
Ocp-Apim-Subscription-Key
Proporcione aquí la clave de la cuenta de Cognitive Services.
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 projects |
Get all projects created in 2018 or 2019 |
Get all projects
Solicitud de ejemplo
GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3
Respuesta de muestra
{
"values": [
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
"links": {
"evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
"datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
"models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
"endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
"transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
},
"properties": {
"datasetCount": 23,
"evaluationCount": 42,
"modelCount": 2,
"transcriptionCount": 1994,
"endpointCount": 12
},
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"displayName": "My speech project"
},
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
"links": {
"evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
"datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
"models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
"endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
"transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
},
"properties": {
"datasetCount": 23,
"evaluationCount": 42,
"modelCount": 2,
"transcriptionCount": 1994,
"endpointCount": 12
},
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"displayName": "My speech project"
},
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
"links": {
"evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
"datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
"models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
"endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
"transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
},
"properties": {
"datasetCount": 23,
"evaluationCount": 42,
"modelCount": 2,
"transcriptionCount": 1994,
"endpointCount": 12
},
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"displayName": "My speech project"
}
],
"@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=3&top=3"
}
Get all projects created in 2018 or 2019
Solicitud de ejemplo
GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z
Respuesta de muestra
{
"values": [
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
"links": {
"evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
"datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
"models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
"endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
"transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
},
"properties": {
"datasetCount": 23,
"evaluationCount": 42,
"modelCount": 2,
"transcriptionCount": 1994,
"endpointCount": 12
},
"createdDateTime": "2018-03-03T12:45:27Z",
"locale": "en-US",
"displayName": "My speech project"
},
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
"links": {
"evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
"datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
"models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
"endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
"transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
},
"properties": {
"datasetCount": 23,
"evaluationCount": 42,
"modelCount": 2,
"transcriptionCount": 1994,
"endpointCount": 12
},
"createdDateTime": "2018-12-19T17:54:57Z",
"locale": "en-US",
"displayName": "My speech project"
},
{
"self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.1/projects/abc46f33-90b8-443d-adad-4870517356e0",
"links": {
"evaluations": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/evaluations",
"datasets": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/datasets",
"models": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models",
"endpoints": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/endpoints",
"transcriptions": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/transcriptions"
},
"properties": {
"datasetCount": 23,
"evaluationCount": 42,
"modelCount": 2,
"transcriptionCount": 1994,
"endpointCount": 12
},
"createdDateTime": "2019-02-01T00:45:27Z",
"locale": "en-US",
"displayName": "My speech project"
}
],
"@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/projects?skip=6&top=3&filter=createdDateTime%20ge%202018-01-01T00:00:00Z%20and%20createdDateTime%20lt%202020-01-01T00:00:00Z"
}
Definiciones
Nombre | Description |
---|---|
Detailed |
DetailedErrorCode |
Error |
Error |
Error |
ErrorCode |
Inner |
InnerError |
Paginated |
PaginatedProjects |
Project |
Proyecto |
Project |
ProjectLinks |
Project |
ProjectProperties |
DetailedErrorCode
DetailedErrorCode
Valor | Description |
---|---|
DataImportFailed |
Error en la importación de datos. |
DeleteNotAllowed |
Eliminar no permitido. |
DeployNotAllowed |
No se permite la implementación. |
DeployingFailedModel |
Se ha producido un error en la implementación del modelo. |
EmptyRequest |
Solicitud vacía. |
EndpointCannotBeDefault |
El punto de conexión no puede ser predeterminado. |
EndpointNotUpdatable |
Punto de conexión no actualizable. |
EndpointWithoutLogging |
Punto de conexión sin registro. |
ExceededNumberOfRecordingsUris |
Se superó el número de uris de grabaciones. |
FailedDataset |
Conjunto de datos con errores. |
Forbidden |
Prohibido. |
InUseViolation |
En infracción de uso. |
InaccessibleCustomerStorage |
Almacenamiento de clientes inaccesible. |
InvalidAdaptationMapping |
Asignación de adaptación no válida. |
InvalidBaseModel |
Modelo base no válido. |
InvalidCallbackUri |
URI de devolución de llamada no válido. |
InvalidCollection |
Colección no válida. |
InvalidDataset |
Conjunto de datos no válido. |
InvalidDocument |
Documento no válido. |
InvalidDocumentBatch |
Lote de documentos no válido. |
InvalidLocale |
Configuración regional no válida. |
InvalidLogDate |
Fecha de registro no válida. |
InvalidLogEndTime |
Hora de finalización del registro no válida. |
InvalidLogId |
Identificador de registro no válido. |
InvalidLogStartTime |
Hora de inicio del registro no válida. |
InvalidModel |
Modelo no válido. |
InvalidModelUri |
URI de modelo no válido. |
InvalidParameter |
Parámetro no válido. |
InvalidParameterValue |
Valor de parámetro no válido. |
InvalidPayload |
Carga no válida. |
InvalidPermissions |
Permisos no válidos. |
InvalidPrerequisite |
Requisito previo no válido. |
InvalidProductId |
Identificador de producto no válido. |
InvalidProject |
Proyecto no válido. |
InvalidProjectKind |
Tipo de proyecto no válido. |
InvalidRecordingsUri |
URI de grabaciones no válidos. |
InvalidRequestBodyFormat |
Formato de cuerpo de la solicitud no válido. |
InvalidSasValidityDuration |
Duración de validez de sas no válida. |
InvalidSkipTokenForLogs |
Token de omisión no válido para los registros. |
InvalidSourceAzureResourceId |
Identificador de recurso de Azure de origen no válido. |
InvalidSubscription |
Suscripción no válida. |
InvalidTest |
Prueba no válida. |
InvalidTimeToLive |
Tiempo de vida no válido. |
InvalidTopForLogs |
Top no válido para los registros. |
InvalidTranscription |
Transcripción no válida. |
InvalidWebHookEventKind |
Tipo de evento web hook no válido. |
MissingInputRecords |
Faltan registros de entrada. |
ModelCopyOperationExists |
Existe una operación de copia del modelo. |
ModelDeploymentNotCompleteState |
La implementación del modelo no está completa. |
ModelDeprecated |
Modelo en desuso. |
ModelExists |
El modelo existe. |
ModelMismatch |
Error de coincidencia del modelo. |
ModelNotDeployable |
El modelo no se puede implementar. |
ModelVersionIncorrect |
Versión del modelo incorrecta. |
NoUtf8WithBom |
No hay utf8 con bom. |
OnlyOneOfUrlsOrContainerOrDataset |
Solo una de direcciones URL o contenedor o conjunto de datos. |
ProjectGenderMismatch |
No coinciden los géneros del proyecto. |
QuotaViolation |
Infracción de cuota. |
SingleDefaultEndpoint |
Punto de conexión predeterminado único. |
SkuLimitsExist |
Existen límites de SKU. |
SubscriptionNotFound |
No se encontró la suscripción. |
UnexpectedError |
Error inesperado. |
UnsupportedClassBasedAdaptation |
Adaptación basada en clases no admitidas. |
UnsupportedDelta |
Delta no admitido. |
UnsupportedDynamicConfiguration |
Configuración dinámica no admitida. |
UnsupportedFilter |
Filtro no admitido. |
UnsupportedLanguageCode |
Código de lenguaje no admitido. |
UnsupportedOrderBy |
Orden no admitido por. |
UnsupportedPagination |
Paginación no admitida. |
UnsupportedTimeRange |
Intervalo de tiempo no admitido. |
Error
Error
Nombre | Tipo | Description |
---|---|---|
code |
ErrorCode |
|
details |
Error[] |
Detalles de apoyo adicionales relacionados con el error o las directivas esperadas. |
innerError |
InnerError |
|
message |
string |
Mensaje de error de alto nivel. |
target |
string |
Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en caso de documento no válido. |
ErrorCode
ErrorCode
Valor | Description |
---|---|
Conflict |
Representa el código de error en conflicto. |
Forbidden |
Representa el código de error prohibido. |
InternalCommunicationFailed |
Representa el código de error de comunicación interna con error. |
InternalServerError |
Representa el código de error interno del servidor. |
InvalidArgument |
Representa el código de error de argumento no válido. |
InvalidRequest |
Representa el código de error de solicitud no válido. |
NotAllowed |
Representa el código de error no permitido. |
NotFound |
Representa el código de error no encontrado. |
PipelineError |
Representa el código de error de canalización. |
ServiceUnavailable |
Representa el código de error del servicio no disponible. |
TooManyRequests |
Representa el código de error de demasiadas solicitudes. |
Unauthorized |
Representa el código de error no autorizado. |
UnprocessableEntity |
Representa el código de error de entidad no procesado. |
UnsupportedMediaType |
Representa el código de error de tipo de medio no admitido. |
InnerError
InnerError
Nombre | Tipo | Description |
---|---|---|
code |
DetailedErrorCode |
|
details |
object |
Detalles de apoyo adicionales relacionados con el error o las directivas esperadas. |
innerError |
InnerError |
|
message |
string |
Mensaje de error de alto nivel. |
target |
string |
Origen del error. Por ejemplo, sería "documentos" o "id. de documento" en caso de documento no válido. |
PaginatedProjects
PaginatedProjects
Nombre | Tipo | Description |
---|---|---|
@nextLink |
string (uri) |
Vínculo al siguiente conjunto de resultados paginados si hay más entidades disponibles; de lo contrario, null. |
values |
Project[] |
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 crear una lista en el cliente y eliminar después de la captura de la lista completa. |
Project
Proyecto
Nombre | Tipo | Description |
---|---|---|
createdDateTime |
string (date-time) |
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 de clave permitida es de 64 caracteres, la longitud máxima permitida del valor es de 256 caracteres y el recuento de entradas permitidas es de 10. |
description |
string |
Descripción del objeto. |
displayName |
string minLength: 1 |
Nombre para mostrar del objeto. |
links |
ProjectLinks |
|
locale |
string minLength: 1 |
Configuración regional de los datos contenidos. |
properties |
ProjectProperties |
|
self |
string (uri) |
Ubicación de esta entidad. |
ProjectLinks
ProjectLinks
Nombre | Tipo | Description |
---|---|---|
datasets |
string (uri) |
Ubicación para obtener una lista de todos los conjuntos de datos de este proyecto. Consulte la operación "Projects_ListDatasets" para obtener más información. |
endpoints |
string (uri) |
Ubicación para obtener una lista de todos los puntos de conexión de este proyecto. Consulte la operación "Projects_ListEndpoints" para obtener más información. |
evaluations |
string (uri) |
Ubicación para obtener una lista de todas las evaluaciones de este proyecto. Consulte la operación "Projects_ListEvaluations" para obtener más información. |
models |
string (uri) |
Ubicación para obtener una lista de todos los modelos de este proyecto. Consulte la operación "Projects_ListModels" para obtener más detalles. |
transcriptions |
string (uri) |
Ubicación para obtener una lista de todas las transcripciones de este proyecto. Consulte la operación "Projects_ListTranscriptions" para obtener más información. |
ProjectProperties
ProjectProperties
Nombre | Tipo | Description |
---|---|---|
datasetCount |
integer (int32) |
Número de conjuntos de datos asociados a este proyecto. |
endpointCount |
integer (int32) |
Número de puntos de conexión asociados a este proyecto. |
evaluationCount |
integer (int32) |
Número de evaluaciones asociadas a este proyecto. |
modelCount |
integer (int32) |
Número de modelos asociados a este proyecto. |
transcriptionCount |
integer (int32) |
Número de transcripciones asociadas a este proyecto. |