Projects - List

Service:
Azure AI Services
API-versie:
v3.2-preview.2

Hiermee haalt u de lijst met projecten voor het geverifieerde abonnement op.

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

URI-parameters

Name In Vereist Type Description
endpoint
 path True

string

Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).
filter
 query

string

Een filterexpressie voor het selecteren van een subset van de beschikbare projecten.

        - 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)

Aantal gegevenssets dat wordt overgeslagen.
top
 query

integer (int32)

Het aantal gegevenssets dat wordt opgenomen na het overslaan.

Antwoorden

Name Type Description
200 OK

PaginatedProjects

OK
Other Status Codes

Error

Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier de sleutel van uw Cognitive Services-account op.

Type: apiKey
In: header

Authorization

Geef een toegangstoken op van de JWT die wordt geretourneerd door de STS van deze regio. Zorg ervoor dat u het beheerbereik aan het token toevoegt door de volgende querytekenreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Get all projects
Get all projects created in 2018 or 2019

Get all projects

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:
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"
}

Definities

Name Description
DetailedErrorCode

DetailedErrorCode
Error

Fout
ErrorCode

ErrorCode
InnerError

InnerError
PaginatedProjects

GepagineerdeProjects
Project

Project
ProjectLinks

ProjectLinks
ProjectProperties

ProjectProperties

DetailedErrorCode

Inventarisatie

DetailedErrorCode

Waarde Description
InvalidParameterValue

Ongeldige parameterwaarde.
InvalidRequestBodyFormat

Ongeldige indeling voor de hoofdtekst van de aanvraag.
EmptyRequest

Lege aanvraag.
MissingInputRecords

Ontbrekende invoerrecords.
InvalidDocument

Ongeldig document.
ModelVersionIncorrect

Modelversie onjuist.
InvalidDocumentBatch

Ongeldige documentbatch.
UnsupportedLanguageCode

Niet-ondersteunde taalcode.
DataImportFailed

Het importeren van gegevens is mislukt.
InUseViolation

Schending van gebruik.
InvalidLocale

Ongeldige landinstelling.
InvalidBaseModel

Ongeldig basismodel.
InvalidAdaptationMapping

Ongeldige aanpassingstoewijzing.
InvalidDataset

Ongeldige gegevensset.
InvalidTest

Ongeldige test.
FailedDataset

Mislukte gegevensset.
InvalidModel

Ongeldig model.
InvalidTranscription

Ongeldige transcriptie.
InvalidPayload

Ongeldige nettolading.
InvalidParameter

Ongeldige parameter.
EndpointWithoutLogging

Eindpunt zonder logboekregistratie.
InvalidPermissions

Ongeldige machtigingen.
InvalidPrerequisite

Ongeldige vereiste.
InvalidProductId

Ongeldige product-id.
InvalidSubscription

Ongeldig abonnement.
InvalidProject

Ongeldig project.
InvalidProjectKind

Ongeldig projecttype.
InvalidRecordingsUri

Ongeldige opnamen-URI.
OnlyOneOfUrlsOrContainerOrDataset

Slechts één van url's of containers of gegevenssets.
ExceededNumberOfRecordingsUris

Het aantal opnamen is overschreden.
ModelMismatch

Model komt niet overeen.
ProjectGenderMismatch

Project geslacht komt niet overeen.
ModelDeprecated

Model afgeschaft.
ModelExists

Het model bestaat.
ModelNotDeployable

Model kan niet worden geïmplementeerd.
EndpointNotUpdatable

Eindpunt kan niet worden bijgewerkt.
SingleDefaultEndpoint

Eén standaardeindpunt.
EndpointCannotBeDefault

Eindpunt kan niet standaard zijn.
InvalidModelUri

Ongeldige model-URI.
SubscriptionNotFound

Abonnement is niet gevonden.
QuotaViolation

Quotumschending.
UnsupportedDelta

Niet-ondersteunde delta.
UnsupportedFilter

Niet-ondersteund filter.
UnsupportedPagination

Niet-ondersteunde paginering.
UnsupportedDynamicConfiguration

Niet-ondersteunde dynamische configuratie.
UnsupportedOrderBy

Niet-ondersteunde volgorde door.
NoUtf8WithBom

Geen utf8 met bom.
ModelDeploymentNotCompleteState

Modelimplementatie is niet voltooid.
SkuLimitsExist

Er bestaan SKU-limieten.
DeployingFailedModel

Het implementeren van een mislukt model.
UnsupportedTimeRange

Niet-ondersteund tijdsbereik.
InvalidLogDate

Ongeldige logboekdatum.
InvalidLogId

Ongeldige logboek-id.
InvalidLogStartTime

Ongeldige begintijd voor logboeken.
InvalidLogEndTime

Ongeldige eindtijd van logboek.
InvalidTopForLogs

Ongeldig bovenaan voor logboeken.
InvalidSkipTokenForLogs

Ongeldig skip-token voor logboeken.
DeleteNotAllowed

Verwijderen is niet toegestaan.
Forbidden

Verboden.
DeployNotAllowed

Implementeren is niet toegestaan.
UnexpectedError

Onverwachte fout.
InvalidCollection

Ongeldige verzameling.
InvalidCallbackUri

Ongeldige callback-URI.
InvalidSasValidityDuration

Ongeldige geldigheidsduur van SAS.
InaccessibleCustomerStorage

Niet-toegankelijke opslag van klanten.
UnsupportedClassBasedAdaptation

Niet-ondersteunde aanpassing op basis van klassen.
InvalidWebHookEventKind

Ongeldig gebeurtenistype webhook.
InvalidTimeToLive

Ongeldige time to live.
InvalidSourceAzureResourceId

Ongeldige azure-bronresource-id.
ModelCopyOperationExists

Er bestaat een modelkopiebewerking.

Error

Object

Fout

Name Type Description
code

ErrorCode

ErrorCode
Foutcodes op hoog niveau.
details

Error[]

Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message

string

Foutbericht op hoog niveau.
target

string

De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ErrorCode

Inventarisatie

ErrorCode

Waarde Description
InvalidRequest

De foutcode van de ongeldige aanvraag vertegenwoordigt.
InvalidArgument

De foutcode van het ongeldige argument vertegenwoordigt.
InternalServerError

De foutcode van de interne server vertegenwoordigt.
ServiceUnavailable

Vertegenwoordiging van de service niet-beschikbare foutcode.
NotFound

De foutcode wordt niet gevonden.
PipelineError

De foutcode van de pijplijnfout weergeven.
Conflict

Vertegenwoordiging van de conflictfoutcode.
InternalCommunicationFailed

De foutcode voor de interne communicatie is mislukt.
Forbidden

Vertegenwoordiging van de verboden foutcode.
NotAllowed

Vertegenwoordiging van de niet-toegestane foutcode.
Unauthorized

Vertegenwoordiging van de niet-geautoriseerde foutcode.
UnsupportedMediaType

De foutcode van het niet-ondersteunde mediatype vertegenwoordigt.
TooManyRequests

De foutcode voor te veel aanvragen vertegenwoordigt.
UnprocessableEntity

De foutcode van de niet-verwerkte entiteit vertegenwoordigt.

InnerError

Object

InnerError

Name Type Description
code

DetailedErrorCode

DetailedErrorCode
Gedetailleerde opsomming van foutcodes.
details

object

Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError

InnerError

InnerError
Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message

string

Foutbericht op hoog niveau.
target

string

De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

PaginatedProjects

Object

GepagineerdeProjects

Name Type Description
@nextLink

string (uri)

Een koppeling naar de volgende set gepagineerde resultaten als er meer entiteiten beschikbaar zijn; anders null.
values

Project[]

Een lijst met entiteiten die worden beperkt door de doorgegeven queryparameters 'skip' en 'top' of de bijbehorende standaardwaarden.

Wanneer u een lijst doorloopt met behulp van paginering en het parallel verwijderen van entiteiten, worden sommige entiteiten overgeslagen in de resultaten. Het is raadzaam om een lijst op de client te maken en te verwijderen na het ophalen van de volledige lijst.

Project

Object

Project

Name Type Description
createdDateTime

string (date-time)

Het tijdstempel waarop het object is gemaakt. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximale toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.
description

string

De beschrijving van het object.
displayName

string

minLength: 1

De weergavenaam van het object.
links

ProjectLinks

ProjectLinks
locale

string

minLength: 1

De landinstelling van de ingesloten gegevens.
properties

ProjectProperties

ProjectProperties
self

string (uri)

De locatie van deze entiteit.
Object

ProjectLinks

Name Type Description
datasets

string (uri)

De locatie voor het ophalen van een lijst met alle gegevenssets van dit project. Zie de bewerking 'Projects_ListDatasets' voor meer informatie.
endpoints

string (uri)

De locatie voor het ophalen van een lijst met alle eindpunten van dit project. Zie de bewerking 'Projects_ListEndpoints' voor meer informatie.
evaluations

string (uri)

De locatie voor een lijst met alle evaluaties van dit project. Zie de bewerking 'Projects_ListEvaluations' voor meer informatie.
models

string (uri)

De locatie voor het ophalen van een lijst met alle modellen van dit project. Zie de bewerking 'Projects_ListModels' voor meer informatie.
transcriptions

string (uri)

De locatie voor een lijst met alle transcripties van dit project. Zie de bewerking 'Projects_ListTranscriptions' voor meer informatie.

ProjectProperties

Object

ProjectProperties

Name Type Description
datasetCount

integer (int32)

Het aantal gegevenssets dat aan dit project is gekoppeld.
endpointCount

integer (int32)

Het aantal eindpunten dat aan dit project is gekoppeld.
evaluationCount

integer (int32)

Het aantal evaluaties dat aan dit project is gekoppeld.
modelCount

integer (int32)

Het aantal modellen dat aan dit project is gekoppeld.
transcriptionCount

integer (int32)

Het aantal transcripties dat aan dit project is gekoppeld.