Get Models - Get Models

Service:: Azure AI Services

API-versie:: v3.0

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

GET {Endpoint}/speechtotext/v3.0/models

Met optionele parameters:

GET {Endpoint}/speechtotext/v3.0/models?skip={skip}&top={top}

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).
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	PaginatedModels	OK Kopteksten Retry-After: integer
Other Status Codes	Error	Er is een fout opgetreden.

Name

Type

Description

200 OK

PaginatedModels

Kopteksten

Retry-After: integer

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 models

Voorbeeldaanvraag

HTTP

GET https://westus.api.cognitive.microsoft.com//speechtotext/v3.0/models?skip=0&top=2

Voorbeeldrespons

Statuscode:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/827712a5-f942-4997-91c3-7c6cde35600b/copy"
      },
      "properties": {
        "deprecationDates": {
          "adaptationDateTime": "2022-11-04T00:00:00Z",
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        }
      },
      "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.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/copy"
      },
      "properties": {
        "deprecationDates": {
          "adaptationDateTime": "2022-11-04T00:00:00Z",
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        }
      },
      "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.0/models?skip=2&top=2"
}

Definities

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Fout
ErrorCode	ErrorCode
InnerError	InnerError
Model	Modelleren
ModelDeprecationDates	ModelDeprecationDates
ModelLinks	ModelLinks
ModelProperties	ModelProperties
PaginatedModels	PaginatedModels
Status	Toestand

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.

EntityError

Object

EntityError

Name	Type	Description
code	string	De code van deze fout.
message	string	Het bericht voor deze fout.

EntityReference

Object

EntityReference

Name	Type	Description
self	string (uri)	De locatie van de entiteit waarnaar wordt verwezen.

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.

Model

Object

Modelleren

Name	Type	Description
baseModel	EntityReference	EntityReference
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.
datasets	EntityReference[]	Gegevenssets die worden gebruikt voor aanpassing.
description	string	De beschrijving van het object.
displayName	string	De weergavenaam van het object.
lastActionDateTime	string (date-time)	Het tijdstempel waarop de huidige status is ingevoerd. 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).
links	ModelLinks	ModelLinks
locale	string	De landinstelling van de ingesloten gegevens.
project	EntityReference	EntityReference
properties	ModelProperties	ModelProperties
self	string (uri)	De locatie van deze entiteit.
status	Status	Toestand De huidige status van de API beschrijven
text	string	De tekst die wordt gebruikt om dit taalmodel aan te passen.

ModelDeprecationDates

Object

ModelDeprecationDates

Name	Type	Description
adaptationDateTime	string (date-time)
transcriptionDateTime	string (date-time)

ModelLinks

Object

ModelLinks

Name	Type	Description
copyTo	string (uri)	De locatie naar de kopieeractie van het model.
manifest	string (uri)	De locatie voor het ophalen van een manifest voor dit model dat moet worden gebruikt in de on-premises container.

ModelProperties

Object

ModelProperties

Name	Type	Description
deprecationDates	ModelDeprecationDates	ModelDeprecationDates
email	string	Het e-mailadres waarnaar e-mailmeldingen moeten worden verzonden voor het geval de bewerking is voltooid. De waarde wordt verwijderd nadat het e-mailbericht is verzonden.
error	EntityError	EntityError

PaginatedModels

Object

PaginatedModels

Name	Type	Description
@nextLink	string (uri)	Een koppeling naar de volgende set gepagineerde resultaten als er meer entiteiten beschikbaar zijn; anders null.
values	Model[]	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.

Name

Type

Description

@nextLink

string (uri)

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

values

Model[]

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.

Status

Inventarisatie

Toestand

Waarde	Description
NotStarted	De langdurige bewerking is nog niet gestart.
Running	De langdurige bewerking wordt momenteel verwerkt.
Succeeded	De langdurige bewerking is voltooid.
Failed	De langdurige bewerking is mislukt.