Freigeben über


Projects - List

Ruft die Liste der Projekte für das authentifizierte Abonnement ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
path True

string

Unterstützte Cognitive Services-Endpunkte (Protokoll und Hostname, z. B. ). https://westus.api.cognitive.microsoft.com

filter
query

string

Ein Filterausdruck zum Auswählen einer Teilmenge der verfügbaren Projekte.

        - 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

Anzahl der Datasets, die übersprungen werden.

top
query

integer

int32

Anzahl der Datasets, die nach dem Überspringen eingeschlossen werden.

Antworten

Name Typ Beschreibung
200 OK

PaginatedProjects

OK

Other Status Codes

Error

Ein Fehler ist aufgetreten.

Sicherheit

Ocp-Apim-Subscription-Key

Geben Sie hier Ihren Cognitive Services-Kontoschlüssel an.

Typ: apiKey
In: header

Authorization

Stellen Sie ein Zugriffstoken aus dem JWT bereit, das vom STS dieser Region zurückgegeben wird. Stellen Sie sicher, dass Sie dem Token den Verwaltungsbereich hinzufügen, indem Sie der STS-URL die folgende Abfragezeichenfolge hinzufügen: ?scope=speechservicesmanagement

Typ: apiKey
In: header

Beispiele

Get all projects
Get all projects created in 2018 or 2019

Get all projects

Beispielanforderung

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

Beispiel für eine Antwort

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

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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"
}

Definitionen

Name Beschreibung
DetailedErrorCode

DetailedErrorCode

Error

Fehler

ErrorCode

ErrorCode

InnerError

InnerError

PaginatedProjects

PaginatedProjects

Project

Project

ProjectLinks

ProjectLinks

ProjectProperties

Projectproperties

DetailedErrorCode

DetailedErrorCode

Name Typ Beschreibung
DataImportFailed

string

Fehler beim Datenimport.

DeleteNotAllowed

string

Löschen nicht zulässig.

DeployNotAllowed

string

Bereitstellen ist nicht zulässig.

DeployingFailedModel

string

Bereitstellen eines fehlerhaften Modells.

EmptyRequest

string

Leere Anforderung.

EndpointCannotBeDefault

string

Der Endpunkt kann nicht standardmäßig sein.

EndpointNotUpdatable

string

Endpunkt nicht aktualisierbar.

EndpointWithoutLogging

string

Endpunkt ohne Protokollierung.

ExceededNumberOfRecordingsUris

string

Die Anzahl der Aufzeichnungsuris wurde überschritten.

FailedDataset

string

Fehlgeschlagenes Dataset.

Forbidden

string

Unzulässig.

InUseViolation

string

In der Nutzungsverletzung.

InaccessibleCustomerStorage

string

Auf den Kundenspeicher kann nicht zugegriffen werden.

InvalidAdaptationMapping

string

Ungültige Anpassungszuordnung.

InvalidBaseModel

string

Ungültiges Basismodell.

InvalidCallbackUri

string

Ungültiger Rückruf-URI.

InvalidCollection

string

Ungültige Auflistung.

InvalidDataset

string

Ungültiges Dataset.

InvalidDocument

string

Ungültiges Dokument.

InvalidDocumentBatch

string

Ungültiger Dokumentbatch.

InvalidLocale

string

Ungültiges Gebietsschema.

InvalidLogDate

string

Ungültiges Protokolldatum.

InvalidLogEndTime

string

Ungültige Protokollendzeit.

InvalidLogId

string

Ungültige Protokoll-ID.

InvalidLogStartTime

string

Ungültige Protokollstartzeit.

InvalidModel

string

Ungültiges Modell.

InvalidModelUri

string

Ungültiger Modell-URI.

InvalidParameter

string

Ungültiger Parameter.

InvalidParameterValue

string

Ungültiger Parameterwert.

InvalidPayload

string

Ungültige Nutzlast.

InvalidPermissions

string

Ungültige Berechtigungen.

InvalidPrerequisite

string

Ungültige Voraussetzung.

InvalidProductId

string

Ungültige Produkt-ID.

InvalidProject

string

Ungültiges Projekt.

InvalidProjectKind

string

Ungültige Projektart.

InvalidRecordingsUri

string

Ungültiger Aufzeichnungs-URI.

InvalidRequestBodyFormat

string

Ungültiges Anforderungstextformat.

InvalidSasValidityDuration

string

Ungültige SAS-Gültigkeitsdauer.

InvalidSkipTokenForLogs

string

Ungültiges Überspringen des Tokens für Protokolle.

InvalidSourceAzureResourceId

string

Ungültige Azure-Quellressourcen-ID.

InvalidSubscription

string

Ungültiges Abonnement.

InvalidTest

string

Ungültiger Test.

InvalidTimeToLive

string

Ungültige Gültigkeitsdauer.

InvalidTopForLogs

string

Ungültiger Anfang für Protokolle.

InvalidTranscription

string

Ungültige Transkription.

InvalidWebHookEventKind

string

Ungültige Webhookereignisart.

MissingInputRecords

string

Fehlende Eingabedatensätze.

ModelCopyOperationExists

string

Modellkopiervorgang ist vorhanden.

ModelDeploymentNotCompleteState

string

Der Status der Modellbereitstellung ist nicht abgeschlossen.

ModelDeprecated

string

Das Modell ist veraltet.

ModelExists

string

Das Modell ist vorhanden.

ModelMismatch

string

Modellkonflikt.

ModelNotDeployable

string

Das Modell kann nicht bereitgestellt werden.

ModelVersionIncorrect

string

Modellversion falsch.

NoUtf8WithBom

string

Kein utf8 mit bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Nur eine der URLs, container oder datasets.

ProjectGenderMismatch

string

Projizieren von Geschlechtskonflikten.

QuotaViolation

string

Kontingentverletzung.

SingleDefaultEndpoint

string

Einzelner Standardendpunkt.

SkuLimitsExist

string

SKU-Grenzwerte sind vorhanden.

SubscriptionNotFound

string

Das Abonnement wurde nicht gefunden.

UnexpectedError

string

Unerwarteter Fehler.

UnsupportedClassBasedAdaptation

string

Nicht unterstützte klassenbasierte Anpassung.

UnsupportedDelta

string

Nicht unterstütztes Delta.

UnsupportedDynamicConfiguration

string

Nicht unterstützte dynamische Konfiguration.

UnsupportedFilter

string

Nicht unterstützter Filter.

UnsupportedLanguageCode

string

Nicht unterstützter Sprachcode.

UnsupportedOrderBy

string

Nicht unterstützte Reihenfolge nach.

UnsupportedPagination

string

Nicht unterstützte Paginierung.

UnsupportedTimeRange

string

Nicht unterstützter Zeitbereich.

Error

Fehler

Name Typ Beschreibung
code

ErrorCode

ErrorCode
Allgemeine Fehlercodes.

details

Error[]

Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.

innerError

InnerError

InnerError
Neues Innere Fehlerformat, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar ist. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).

message

string

Allgemeine Fehlermeldung.

target

string

Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

ErrorCode

ErrorCode

Name Typ Beschreibung
Conflict

string

Stellt den Konfliktfehlercode dar.

Forbidden

string

Stellt den unzulässigen Fehlercode dar.

InternalCommunicationFailed

string

Stellt den fehlerlosen Fehlercode für die interne Kommunikation dar.

InternalServerError

string

Stellt den internen Fehlercode des Servers dar.

InvalidArgument

string

Stellt den Fehlercode des ungültigen Arguments dar.

InvalidRequest

string

Stellt den ungültigen Anforderungsfehlercode dar.

NotAllowed

string

Stellt den nicht zulässigen Fehlercode dar.

NotFound

string

Stellt den nicht gefundenen Fehlercode dar.

PipelineError

string

Stellt den Pipelinefehlerfehlercode dar.

ServiceUnavailable

string

Stellt den nicht verfügbaren Fehlercode des Diensts dar.

TooManyRequests

string

Stellt den Fehlercode für zu viele Anforderungen dar.

Unauthorized

string

Stellt den nicht autorisierten Fehlercode dar.

UnprocessableEntity

string

Stellt den Fehlercode für nicht bearbeitbare Entitäten dar.

UnsupportedMediaType

string

Stellt den Fehlercode für nicht unterstützte Medientypen dar.

InnerError

InnerError

Name Typ Beschreibung
code

DetailedErrorCode

DetailedErrorCode
Detaillierte Fehlercodeenume.

details

object

Zusätzliche unterstützende Details zum Fehler und/oder zu den erwarteten Richtlinien.

innerError

InnerError

InnerError
Neues Innere Fehlerformat, das den Cognitive Services-API-Richtlinien entspricht, die unter https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8owverfügbar ist. Enthält die erforderlichen Eigenschaften ErrorCode, Message und Optional Properties Target, Details (Key Value Pair), Inner Error (kann geschachtelt werden).

message

string

Allgemeine Fehlermeldung.

target

string

Die Ursache des Fehlers. Dies wäre z. B. „Dokumente“ oder „Dokument-ID“ im Falle eines ungültigen Dokuments.

PaginatedProjects

PaginatedProjects

Name Typ Beschreibung
@nextLink

string

Ein Link zum nächsten Satz paginierter Ergebnisse, wenn weitere Entitäten verfügbar sind; andernfalls null.

values

Project[]

Eine Liste von Entitäten, die entweder durch die übergebenen Abfrageparameter "skip" und "top" oder deren Standardwerte eingeschränkt sind.

Beim Durchlaufen einer Liste mit Paginierung und parallelem Löschen von Entitäten werden einige Entitäten in den Ergebnissen übersprungen. Es wird empfohlen, eine Liste auf dem Client zu erstellen und nach dem Abrufen der vollständigen Liste zu löschen.

Project

Project

Name Typ Beschreibung
createdDateTime

string

Der Zeitstempel, bei dem das Objekt erstellt wurde. Der Zeitstempel ist als ISO 8601-Datums- und Uhrzeitformat codiert ("JJJJ-MM-TTThh:mm:ssZ", siehe https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

customProperties

object

Die benutzerdefinierten Eigenschaften dieser Entität. Die maximal zulässige Schlüssellänge beträgt 64 Zeichen, die maximal zulässige Wertlänge 256 Zeichen und die Anzahl der zulässigen Einträge beträgt 10.

description

string

Die Beschreibung des -Objekts.

displayName

string

Der Anzeigename des Objekts.

links

ProjectLinks

ProjectLinks

locale

string

Das Gebietsschema der enthaltenen Daten.

properties

ProjectProperties

Projectproperties

self

string

Der Speicherort dieser Entität.

ProjectLinks

Name Typ Beschreibung
datasets

string

Der Speicherort, an dem eine Liste aller Datasets dieses Projekts abgerufen werden soll. Weitere Informationen finden Sie unter Vorgang "Projects_ListDatasets".

endpoints

string

Der Speicherort, an dem eine Liste aller Endpunkte dieses Projekts abgerufen werden soll. Weitere Informationen finden Sie unter Vorgang "Projects_ListEndpoints".

evaluations

string

Der Speicherort, an dem eine Liste aller Bewertungen dieses Projekts abgerufen werden soll. Weitere Informationen finden Sie unter Vorgang "Projects_ListEvaluations".

models

string

Der Speicherort, an dem eine Liste aller Modelle dieses Projekts abgerufen werden soll. Weitere Informationen finden Sie unter Vorgang "Projects_ListModels".

transcriptions

string

Der Speicherort, an dem eine Liste aller Transkriptionen dieses Projekts abgerufen werden soll. Weitere Informationen finden Sie unter Vorgang "Projects_ListTranscriptions".

ProjectProperties

Projectproperties

Name Typ Beschreibung
datasetCount

integer

Die Anzahl der Datasets, die diesem Projekt zugeordnet sind.

endpointCount

integer

Die Anzahl der Endpunkte, die diesem Projekt zugeordnet sind.

evaluationCount

integer

Die Anzahl der Bewertungen, die diesem Projekt zugeordnet sind.

modelCount

integer

Die Anzahl der diesem Projekt zugeordneten Modelle.

transcriptionCount

integer

Die Anzahl der Transkriptionen, die diesem Projekt zugeordnet sind.