Projects - List

Service:
Azure AI Services
Version d'API:
v3.2-preview.2

Obtient la liste des projets pour l’abonnement authentifié.

GET {endpoint}/speechtotext/v3.2-preview.2/projects
Avec des paramètres facultatifs: 
GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip={skip}&top={top}&filter={filter}

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com).
filter
 query

string

Expression de filtrage permettant de sélectionner un sous-ensemble des projets disponibles.

        - Supported properties: displayName, description, createdDateTime, locale.

        - Operators:

          - eq, ne are supported for all properties.

          - gt, ge, lt, le are supported for createdDateTime.

          - and, or, not are supported.

        - Example:

          filter=displayName eq 'My test'
skip
 query

integer (int32)

Nombre de jeux de données ignorés.
top
 query

integer (int32)

Nombre de jeux de données qui seront inclus après l’ignorer.

Réponses

Nom Type Description
200 OK

PaginatedProjects

D’ACCORD
Other Status Codes

Error

Une erreur s’est produite.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez ici votre clé de compte Cognitive Services.

Type: apiKey
Dans: header

Authorization

Fournissez un jeton d’accès à partir du JWT retourné par le STS de cette région. Veillez à ajouter l’étendue de gestion au jeton en ajoutant la chaîne de requête suivante à l’URL STS : ?scope=speechservicesmanagement

Type: apiKey
Dans: header

Exemples

Get all projects
Get all projects created in 2018 or 2019

Get all projects

Exemple de requête

GET {endpoint}/speechtotext/v3.2-preview.2/projects?skip=0&top=3

Exemple de réponse

Code d’état:
200 
{
  "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

Exemple de requête

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

Exemple de réponse

Code d’état:
200 
{
  "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"
}

Définitions

Nom Description
DetailedErrorCode

DetailedErrorCode
Error

Erreur
ErrorCode

Code d'erreur
InnerError

InnerError
PaginatedProjects

PaginédProjects
Project

Projet
ProjectLinks

ProjectLinks
ProjectProperties

ProjectProperties

DetailedErrorCode

Énumération

DetailedErrorCode

Valeur Description
InvalidParameterValue

Valeur de paramètre non valide.
InvalidRequestBodyFormat

Format du corps de la demande non valide.
EmptyRequest

Requête vide.
MissingInputRecords

Enregistrements d’entrée manquants.
InvalidDocument

Document non valide.
ModelVersionIncorrect

Version du modèle incorrecte.
InvalidDocumentBatch

Lot de documents non valide.
UnsupportedLanguageCode

Code de langue non pris en charge.
DataImportFailed

Échec de l’importation de données.
InUseViolation

En cas de violation d’utilisation.
InvalidLocale

Paramètres régionaux non valides.
InvalidBaseModel

Modèle de base non valide.
InvalidAdaptationMapping

Mappage d’adaptation non valide.
InvalidDataset

Jeu de données non valide.
InvalidTest

Test non valide.
FailedDataset

Jeu de données ayant échoué.
InvalidModel

Modèle non valide.
InvalidTranscription

Transcription non valide.
InvalidPayload

Charge utile non valide.
InvalidParameter

Paramètre non valide.
EndpointWithoutLogging

Point de terminaison sans journalisation.
InvalidPermissions

Autorisations non valides.
InvalidPrerequisite

Prérequis non valides.
InvalidProductId

ID de produit non valide.
InvalidSubscription

Abonnement non valide.
InvalidProject

Projet non valide.
InvalidProjectKind

Type de projet non valide.
InvalidRecordingsUri

Uri des enregistrements non valides.
OnlyOneOfUrlsOrContainerOrDataset

Une seule URL ou conteneur ou jeu de données.
ExceededNumberOfRecordingsUris

Nombre dépassé d’uris d’enregistrement.
ModelMismatch

Incompatibilité du modèle.
ProjectGenderMismatch

Incompatibilité entre les sexes du projet.
ModelDeprecated

Modèle déconseillé.
ModelExists

Le modèle existe.
ModelNotDeployable

Modèle non déployable.
EndpointNotUpdatable

Point de terminaison non modifiable.
SingleDefaultEndpoint

Point de terminaison par défaut unique.
EndpointCannotBeDefault

Le point de terminaison ne peut pas être par défaut.
InvalidModelUri

URI de modèle non valide.
SubscriptionNotFound

Abonnement introuvable.
QuotaViolation

Violation de quota.
UnsupportedDelta

Delta non pris en charge.
UnsupportedFilter

Filtre non pris en charge.
UnsupportedPagination

Pagination non prise en charge.
UnsupportedDynamicConfiguration

Configuration dynamique non prise en charge.
UnsupportedOrderBy

Commande non prise en charge par.
NoUtf8WithBom

Pas d’utf8 avec bom.
ModelDeploymentNotCompleteState

Le déploiement du modèle n’est pas terminé.
SkuLimitsExist

Les limites de référence SKU existent.
DeployingFailedModel

Déploiement d’un modèle ayant échoué.
UnsupportedTimeRange

Intervalle de temps non pris en charge.
InvalidLogDate

Date de journal non valide.
InvalidLogId

ID de journal non valide.
InvalidLogStartTime

Heure de début du journal non valide.
InvalidLogEndTime

Heure de fin du journal non valide.
InvalidTopForLogs

Top non valide pour les journaux d’activité.
InvalidSkipTokenForLogs

Jeton d’ignorer non valide pour les journaux d’activité.
DeleteNotAllowed

Supprimer non autorisé.
Forbidden

Interdit.
DeployNotAllowed

Déployer non autorisé.
UnexpectedError

Erreur inattendue.
InvalidCollection

Collection non valide.
InvalidCallbackUri

URI de rappel non valide.
InvalidSasValidityDuration

Durée de validité de sas non valide.
InaccessibleCustomerStorage

Stockage client inaccessible.
UnsupportedClassBasedAdaptation

Adaptation basée sur des classes non prise en charge.
InvalidWebHookEventKind

Type d’événement web hook non valide.
InvalidTimeToLive

Heure de vie non valide.
InvalidSourceAzureResourceId

ID de ressource Azure source non valide.
ModelCopyOperationExists

L’opération de copie de modèle existe.

Error

Object

Erreur

Nom Type Description
code

ErrorCode

Code d'erreur
Codes d’erreur de haut niveau.
details

Error[]

Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError

InnerError

InnerError
Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message

string

Message d’erreur de haut niveau.
target

string

Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

ErrorCode

Énumération

Code d'erreur

Valeur Description
InvalidRequest

Représentant le code d’erreur de requête non valide.
InvalidArgument

Représentant le code d’erreur d’argument non valide.
InternalServerError

Représentant le code d’erreur du serveur interne.
ServiceUnavailable

Représentant le code d’erreur indisponible du service.
NotFound

Représentant le code d’erreur introuvable.
PipelineError

Représentant le code d’erreur du pipeline.
Conflict

Représentant le code d’erreur de conflit.
InternalCommunicationFailed

Représentant le code d’erreur de communication interne ayant échoué.
Forbidden

Représentant le code d’erreur interdit.
NotAllowed

Représentant le code d’erreur non autorisé.
Unauthorized

Représentant le code d’erreur non autorisé.
UnsupportedMediaType

Représentant le code d’erreur du type de média non pris en charge.
TooManyRequests

Représentant le code d’erreur trop grand nombre de requêtes.
UnprocessableEntity

Représentant le code d’erreur d’entité non traité.

InnerError

Object

InnerError

Nom Type Description
code

DetailedErrorCode

DetailedErrorCode
Énumération détaillée du code d’erreur.
details

object

Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError

InnerError

InnerError
Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message

string

Message d’erreur de haut niveau.
target

string

Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

PaginatedProjects

Object

PaginédProjects

Nom Type Description
@nextLink

string (uri)

Lien vers l’ensemble suivant de résultats paginés s’il existe davantage d’entités disponibles ; sinon null.
values

Project[]

Liste des entités limitées par les paramètres de requête passés « skip » et « top » ou leurs valeurs par défaut.

Lors de l’itération dans une liste à l’aide de la pagination et de la suppression d’entités en parallèle, certaines entités sont ignorées dans les résultats. Il est recommandé de créer une liste sur le client et de supprimer après la récupération de la liste complète.

Project

Object

Projet

Nom Type Description
createdDateTime

string (date-time)

Horodatage de la création de l’objet. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
description

string

Description de l’objet.
displayName

string

minLength: 1

Nom complet de l’objet.
links

ProjectLinks

ProjectLinks
locale

string

minLength: 1

Paramètres régionaux des données contenues.
properties

ProjectProperties

ProjectProperties
self

string (uri)

Emplacement de cette entité.
Object

ProjectLinks

Nom Type Description
datasets

string (uri)

Emplacement pour obtenir la liste de tous les jeux de données de ce projet. Pour plus d’informations, consultez l’opération « Projects_ListDatasets ».
endpoints

string (uri)

Emplacement pour obtenir la liste de tous les points de terminaison de ce projet. Pour plus d’informations, consultez l’opération « Projects_ListEndpoints ».
evaluations

string (uri)

Emplacement pour obtenir la liste de toutes les évaluations de ce projet. Pour plus d’informations, consultez l’opération « Projects_ListEvaluations ».
models

string (uri)

Emplacement pour obtenir la liste de tous les modèles de ce projet. Pour plus d’informations, consultez l’opération « Projects_ListModels ».
transcriptions

string (uri)

Emplacement pour obtenir la liste de toutes les transcriptions de ce projet. Pour plus d’informations, consultez l’opération « Projects_ListTranscriptions ».

ProjectProperties

Object

ProjectProperties

Nom Type Description
datasetCount

integer (int32)

Nombre de jeux de données associés à ce projet.
endpointCount

integer (int32)

Nombre de points de terminaison associés à ce projet.
evaluationCount

integer (int32)

Nombre d’évaluations associées à ce projet.
modelCount

integer (int32)

Nombre de modèles associés à ce projet.
transcriptionCount

integer (int32)

Nombre de transcriptions associées à ce projet.