Projects - List Models

Referentie

Service:: Azure AI Services

API-versie:: v3.2-preview.2

Hiermee haalt u de lijst met modellen voor het opgegeven project op.

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/models

Met optionele parameters:

GET {endpoint}/speechtotext/v3.2-preview.2/projects/{id}/models?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).
id	path	True	string (uuid)	De id van het project.
filter	query		string	Een filterexpressie voor het selecteren van een subset van de beschikbare modellen. `- Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=status eq 'NotStarted' or status eq 'Running'`
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	PaginatedCustomModels	OK Kopteksten Retry-After: integer
Other Status Codes	Error	Er is een fout opgetreden.

Name

Type

Description

200 OK

PaginatedCustomModels

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 {endpoint}/speechtotext/v3.2-preview.2/projects/abc46f33-90b8-443d-adad-4870517356e0/models?skip=0&top=2&filter=status%20eq%20'Running'

Voorbeeldrespons

Statuscode:: 200

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "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.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
        "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copyto",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b/files"
      },
      "properties": {
        "deprecationDates": {
          "transcriptionDateTime": "2023-05-04T00:00:00Z"
        },
        "customModelWeightPercent": 30,
        "features": {
          "supportsTranscriptions": true,
          "supportsEndpoints": true,
          "supportsTranscriptionsOnSpeechContainers": false,
          "supportedOutputFormats": [
            "Lexical",
            "Display"
          ]
        }
      },
      "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.2-preview.2/models?skip=2&top=2&filter=status%20eq%20'Running'"
}

Definities

Name	Description
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Fout
ErrorCode	ErrorCode
InnerError	InnerError
OutputFormatType	OutputFormatType
PaginatedCustomModels	GepagineerdCustomModels
Status	Toestand

CustomModel

Object

CustomModel

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 minLength: 1	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	CustomModelLinks	CustomModelLinks
locale	string minLength: 1	De landinstelling van de ingesloten gegevens.
project	EntityReference	EntityReference
properties	CustomModelProperties	CustomModelProperties
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.

CustomModelDeprecationDates

Object

CustomModelDeprecationDates

Name	Type	Description
transcriptionDateTime	string (date-time)	De datum waarop transcriptie wordt afgeschaft.

CustomModelFeatures

Object

CustomModelFeatures

Name	Type	Description
supportedOutputFormats	OutputFormatType[]	Ondersteunde uitvoerindelingen.
supportsEndpoints	boolean	Een waarde die aangeeft of het maken van eindpunten voor livetranscriptie wordt ondersteund.
supportsTranscriptions	boolean	Een waarde die aangeeft of batchtranscriptie wordt ondersteund.
supportsTranscriptionsOnSpeechContainers	boolean	Een waarde die aangeeft of dit model kan worden gebruikt voor transcriptie op spraakcontainer. Deze functie kan worden toegevoegd aan bestaande modellen wanneer deze bruikbaar wordt in de spraakcontainer.

CustomModelLinks

Object

CustomModelLinks

Name	Type	Description
copy	string (uri)	De locatie naar de kopieeractie van het model. Zie de bewerking 'Models_Copy' voor meer informatie.
copyTo	string (uri)	De locatie naar de verouderde actie voor het kopiëren van het model. Zie de bewerking 'Models_CopyTo' voor meer informatie.
files	string (uri)	De locatie om alle bestanden van deze entiteit op te halen. Zie de bewerking 'Models_ListFiles' voor meer informatie.
manifest	string (uri)	De locatie voor het ophalen van een manifest voor dit model dat moet worden gebruikt in de on-premises container. Zie de bewerking 'Models_GetCustomModelManifest' voor meer informatie.

CustomModelProperties

Object

CustomModelProperties

Name	Type	Description
customModelWeightPercent	integer (int32) minimum: 1 maximum: 100	Het gewicht van het aangepaste model tussen 1 (1% aangepast model en 99% basismodel) en 100 (100% aangepast model en 0% basismodel). Wanneer deze eigenschap niet is ingesteld, kiest de service een geschikte waarde (haal het model op om het geselecteerde gewicht op te halen). Begin zonder deze eigenschap te gebruiken. Kies indien nodig een groter (of kleiner) gewicht om de impact van het aangepaste model te vergroten (of te verlagen).
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
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
features	CustomModelFeatures	CustomModelFeatures Functies die worden ondersteund door het model.

DetailedErrorCode

Inventarisatie

DetailedErrorCode

Waarde	Description
DataImportFailed	Het importeren van gegevens is mislukt.
DeleteNotAllowed	Verwijderen is niet toegestaan.
DeployNotAllowed	Implementeren is niet toegestaan.
DeployingFailedModel	Het implementeren van een mislukt model.
EmptyRequest	Lege aanvraag.
EndpointCannotBeDefault	Eindpunt kan niet standaard zijn.
EndpointNotUpdatable	Eindpunt kan niet worden bijgewerkt.
EndpointWithoutLogging	Eindpunt zonder logboekregistratie.
ExceededNumberOfRecordingsUris	Het aantal opnamen is overschreden.
FailedDataset	Mislukte gegevensset.
Forbidden	Verboden.
InUseViolation	Schending van gebruik.
InaccessibleCustomerStorage	Niet-toegankelijke opslag van klanten.
InvalidAdaptationMapping	Ongeldige aanpassingstoewijzing.
InvalidBaseModel	Ongeldig basismodel.
InvalidCallbackUri	Ongeldige callback-URI.
InvalidCollection	Ongeldige verzameling.
InvalidDataset	Ongeldige gegevensset.
InvalidDocument	Ongeldig document.
InvalidDocumentBatch	Ongeldige documentbatch.
InvalidLocale	Ongeldige landinstelling.
InvalidLogDate	Ongeldige logboekdatum.
InvalidLogEndTime	Ongeldige eindtijd van logboek.
InvalidLogId	Ongeldige logboek-id.
InvalidLogStartTime	Ongeldige begintijd voor logboeken.
InvalidModel	Ongeldig model.
InvalidModelUri	Ongeldige model-URI.
InvalidParameter	Ongeldige parameter.
InvalidParameterValue	Ongeldige parameterwaarde.
InvalidPayload	Ongeldige nettolading.
InvalidPermissions	Ongeldige machtigingen.
InvalidPrerequisite	Ongeldige vereiste.
InvalidProductId	Ongeldige product-id.
InvalidProject	Ongeldig project.
InvalidProjectKind	Ongeldig projecttype.
InvalidRecordingsUri	Ongeldige opnamen-URI.
InvalidRequestBodyFormat	Ongeldige indeling voor de hoofdtekst van de aanvraag.
InvalidSasValidityDuration	Ongeldige geldigheidsduur van SAS.
InvalidSkipTokenForLogs	Ongeldig skip-token voor logboeken.
InvalidSourceAzureResourceId	Ongeldige azure-bronresource-id.
InvalidSubscription	Ongeldig abonnement.
InvalidTest	Ongeldige test.
InvalidTimeToLive	Ongeldige time to live.
InvalidTopForLogs	Ongeldig bovenaan voor logboeken.
InvalidTranscription	Ongeldige transcriptie.
InvalidWebHookEventKind	Ongeldig gebeurtenistype webhook.
MissingInputRecords	Ontbrekende invoerrecords.
ModelCopyOperationExists	Er bestaat een modelkopiebewerking.
ModelDeploymentNotCompleteState	Modelimplementatie is niet voltooid.
ModelDeprecated	Model afgeschaft.
ModelExists	Het model bestaat.
ModelMismatch	Model komt niet overeen.
ModelNotDeployable	Model kan niet worden geïmplementeerd.
ModelVersionIncorrect	Modelversie onjuist.
NoUtf8WithBom	Geen utf8 met bom.
OnlyOneOfUrlsOrContainerOrDataset	Slechts één van url's of containers of gegevenssets.
ProjectGenderMismatch	Project geslacht komt niet overeen.
QuotaViolation	Quotumschending.
SingleDefaultEndpoint	Eén standaardeindpunt.
SkuLimitsExist	Er bestaan SKU-limieten.
SubscriptionNotFound	Abonnement is niet gevonden.
UnexpectedError	Onverwachte fout.
UnsupportedClassBasedAdaptation	Niet-ondersteunde aanpassing op basis van klassen.
UnsupportedDelta	Niet-ondersteunde delta.
UnsupportedDynamicConfiguration	Niet-ondersteunde dynamische configuratie.
UnsupportedFilter	Niet-ondersteund filter.
UnsupportedLanguageCode	Niet-ondersteunde taalcode.
UnsupportedOrderBy	Niet-ondersteunde volgorde door.
UnsupportedPagination	Niet-ondersteunde paginering.
UnsupportedTimeRange	Niet-ondersteund tijdsbereik.

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
Conflict	Vertegenwoordiging van de conflictfoutcode.
Forbidden	Vertegenwoordiging van de verboden foutcode.
InternalCommunicationFailed	De foutcode voor de interne communicatie is mislukt.
InternalServerError	De foutcode van de interne server vertegenwoordigt.
InvalidArgument	De foutcode van het ongeldige argument vertegenwoordigt.
InvalidRequest	De foutcode van de ongeldige aanvraag vertegenwoordigt.
NotAllowed	Vertegenwoordiging van de niet-toegestane foutcode.
NotFound	De foutcode wordt niet gevonden.
PipelineError	De foutcode van de pijplijnfout weergeven.
ServiceUnavailable	Vertegenwoordiging van de service niet-beschikbare foutcode.
TooManyRequests	De foutcode voor te veel aanvragen vertegenwoordigt.
Unauthorized	Vertegenwoordiging van de niet-geautoriseerde foutcode.
UnprocessableEntity	De foutcode van de niet-verwerkte entiteit vertegenwoordigt.
UnsupportedMediaType	De foutcode van het niet-ondersteunde mediatype 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.

OutputFormatType

Inventarisatie

OutputFormatType

Waarde	Description
Display	Model ondersteunt weergavetranscriptiesuitvoer of eindpunten.
Lexical	Model biedt de transcriptieuitvoer zonder opmaak.

PaginatedCustomModels

Object

GepagineerdCustomModels

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

CustomModel[]

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
Failed	De langdurige bewerking is mislukt.
NotStarted	De langdurige bewerking is nog niet gestart.
Running	De langdurige bewerking wordt momenteel verwerkt.
Succeeded	De langdurige bewerking is voltooid.

Delen via

Projects - List Models

URI-parameters

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Authorization

Voorbeelden

Get all models

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

OutputFormatType

PaginatedCustomModels

Status

Aanvullende resources