Models - List Custom Models

  • Referens
Tjänst:
Azure AI Services
API-version:
3.2

Hämtar listan över anpassade modeller för den autentiserade prenumerationen.

GET {endpoint}/speechtotext/v3.2/models
Med valfria parametrar: 
GET {endpoint}/speechtotext/v3.2/models?skip={skip}&top={top}&filter={filter}

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
filter
 query

string

Ett filtreringsuttryck för att välja en delmängd av de tillgängliga modellerna.

        - 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

Antal datauppsättningar som ska hoppas över.
top
 query

integer

int32

Antal datauppsättningar som ska tas med när du hoppar över.

Svar

Name Typ Description
200 OK

PaginatedCustomModels

OK

Sidhuvuden

Retry-After: integer
Other Status Codes

Error

Ett fel inträffade.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Typ: apiKey
I: header

Authorization

Ange en åtkomsttoken från den JWT som returneras av STS i den här regionen. Se till att lägga till hanteringsomfånget i token genom att lägga till följande frågesträng i STS-URL:en: ?scope=speechservicesmanagement

Typ: apiKey
I: header

Exempel

Get all models in state 'Running'

Exempelbegäran

GET {endpoint}/speechtotext/v3.2/models?skip=0&top=2&filter=status%20eq%20'Running'

Exempelsvar

Statuskod:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/827712a5-f942-4997-91c3-7c6cde35600b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
      "baseModel": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "datasets": [
        {
          "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
        }
      ],
      "links": {
        "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/endpoints/manifest/a04e77e6-2009-462c-8d1c-65d718ee4b7b",
        "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/a04e77e6-2009-462c-8d1c-65d718ee4b7b:copy",
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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/models?skip=2&top=2&filter=status%20eq%20'Running'"
}

Definitioner

Name Description
CustomModel

CustomModel
CustomModelDeprecationDates

CustomModelDeprecationDates
CustomModelFeatures

CustomModelFeatures
CustomModelLinks

CustomModelLinks
CustomModelProperties

CustomModelProperties
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
EntityReference

EntityReference
Error

Fel
ErrorCode

Felkod
InnerError

InnerError
OutputFormatType

OutputFormatType
PaginatedCustomModels

SidnumreradeCustomModels
Status

Status

CustomModel

CustomModel

Name Typ Description
baseModel

EntityReference

EntityReference
createdDateTime

string

Tidsstämpeln när objektet skapades. Tidsstämpeln kodas som datum- och tidsformatet ISO 8601 ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
datasets

EntityReference[]

Datauppsättningar som används för anpassning.
description

string

Beskrivningen av objektet.
displayName

string

Objektets visningsnamn.
lastActionDateTime

string

Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln kodas som datum- och tidsformatet ISO 8601 ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

CustomModelLinks

CustomModelLinks
locale

string

Nationella inställningar för inneslutna data.
project

EntityReference

EntityReference
properties

CustomModelProperties

CustomModelProperties
self

string

Platsen för den här entiteten.
status

Status

Status
Beskriv API:ets aktuella tillstånd.
text

string

Den text som används för att anpassa den här språkmodellen.

CustomModelDeprecationDates

CustomModelDeprecationDates

Name Typ Description
transcriptionDateTime

string

Det datum då transkriptionen blir inaktuell.

CustomModelFeatures

CustomModelFeatures

Name Typ Description
supportedOutputFormats

OutputFormatType[]

Utdataformat som stöds.
supportsEndpoints

boolean

Ett värde som anger om det finns stöd för att skapa slutpunkter för live-transkription.
supportsTranscriptions

boolean

Ett värde som anger om batch-transkription stöds.
supportsTranscriptionsOnSpeechContainers

boolean

Ett värde som anger om den här modellen kan användas för transkription i talcontainern. Den här funktionen kan läggas till på befintliga modeller när den blir användbar i talcontainern.

CustomModelLinks

Name Typ Description
copy

string

Platsen för modellkopieringsåtgärden. Mer information finns i åtgärden "Models_Copy".
files

string

Platsen för att hämta alla filer för den här entiteten. Mer information finns i åtgärden "Models_ListFiles".
manifest

string

Platsen för att hämta ett manifest för den här modellen som ska användas i den lokala containern. Mer information finns i åtgärden "Models_GetCustomModelManifest".

CustomModelProperties

CustomModelProperties

Name Typ Description
customModelWeightPercent

integer

Vikten för den anpassade modellen mellan 1 (1 % anpassad modell och 99 % basmodell) och 100 (100 % anpassad modell och 0 % basmodell). När den här egenskapen inte har angetts väljer tjänsten ett lämpligt värde (hämta modellen för att hämta den valda vikten). Börja utan att använda den här egenskapen. Om det behövs väljer du en större (eller mindre) vikt för att öka (eller minska) effekten av den anpassade modellen.
deprecationDates

CustomModelDeprecationDates

CustomModelDeprecationDates
email

string

E-postadressen som e-postaviseringar ska skickas till om åtgärden slutförs. Värdet tas bort när e-postmeddelandet har skickats.
error

EntityError

EntityError
features

CustomModelFeatures

CustomModelFeatures
Funktioner som stöds av modellen.

DetailedErrorCode

DetailedErrorCode

Name Typ Description
DataImportFailed

string

Dataimporten misslyckades.
DeleteNotAllowed

string

Ta bort tillåts inte.
DeployNotAllowed

string

Distribution tillåts inte.
DeployingFailedModel

string

Det gick inte att distribuera modellen.
EmptyRequest

string

Tom begäran.
EndpointCannotBeDefault

string

Slutpunkten kan inte vara standard.
EndpointNotUpdatable

string

Slutpunkten kan inte uppdateras.
EndpointWithoutLogging

string

Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris

string

Överskred antalet inspelningar.
FailedDataset

string

Datauppsättningen misslyckades.
Forbidden

string

Förbjudet.
InUseViolation

string

Vid användningsöverträdelse.
InaccessibleCustomerStorage

string

Otillgänglig kundlagring.
InvalidAdaptationMapping

string

Ogiltig anpassningsmappning.
InvalidBaseModel

string

Ogiltig basmodell.
InvalidCallbackUri

string

Ogiltig återanrops-URI.
InvalidChannels

string

Ogiltiga kanaler.
InvalidCollection

string

Ogiltig samling.
InvalidDataset

string

Ogiltig datauppsättning.
InvalidDocument

string

Ogiltigt dokument.
InvalidDocumentBatch

string

Ogiltig dokumentbatch.
InvalidLocale

string

Ogiltigt språk.
InvalidLogDate

string

Ogiltigt loggdatum.
InvalidLogEndTime

string

Ogiltig sluttid för logg.
InvalidLogId

string

Ogiltigt logg-ID.
InvalidLogStartTime

string

Ogiltig starttid för logg.
InvalidModel

string

Ogiltig modell.
InvalidModelUri

string

Ogiltig modell-URI.
InvalidParameter

string

Ogiltig parameter.
InvalidParameterValue

string

Ogiltigt parametervärde.
InvalidPayload

string

Ogiltig nyttolast.
InvalidPermissions

string

Ogiltiga behörigheter.
InvalidPrerequisite

string

Ogiltigt krav.
InvalidProductId

string

Ogiltigt produkt-ID.
InvalidProject

string

Ogiltigt projekt.
InvalidProjectKind

string

Ogiltig projekttyp.
InvalidRecordingsUri

string

Ogiltig inspelnings-URI.
InvalidRequestBodyFormat

string

Ogiltigt format för begärandetext.
InvalidSasValidityDuration

string

Ogiltig varaktighet för SAS-giltighet.
InvalidSkipTokenForLogs

string

Ogiltig hopptoken för loggar.
InvalidSourceAzureResourceId

string

Ogiltigt käll-resurs-ID för Azure.
InvalidSubscription

string

Ogiltig prenumeration.
InvalidTest

string

Ogiltigt test.
InvalidTimeToLive

string

Ogiltigt time to live.
InvalidTopForLogs

string

Ogiltig topp för loggar.
InvalidTranscription

string

Ogiltig transkription.
InvalidWebHookEventKind

string

Ogiltig webhookhändelsetyp.
MissingInputRecords

string

Indataposter saknas.
ModelCopyAuthorizationExpired

string

ModelCopyAuthorization har upphört att gälla.
ModelDeploymentNotCompleteState

string

Modelldistributionen är inte fullständigt.
ModelDeprecated

string

Modellen är inaktuell.
ModelExists

string

Modellen finns.
ModelMismatch

string

Modellmatchningsfel.
ModelNotDeployable

string

Modellen kan inte distribueras.
ModelVersionIncorrect

string

Felaktig modellversion.
NoUtf8WithBom

string

Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset

string

Endast en av URL:erna, containern eller datauppsättningen.
ProjectGenderMismatch

string

Projektets könsmatchningsfel.
QuotaViolation

string

Kvotöverträdelse.
SingleDefaultEndpoint

string

Enskild standardslutpunkt.
SkuLimitsExist

string

Det finns SKU-gränser.
SubscriptionNotFound

string

Det går inte att hitta prenumerationen.
UnexpectedError

string

Oväntat fel.
UnsupportedClassBasedAdaptation

string

Klassbaserad anpassning stöds inte.
UnsupportedDelta

string

Delta stöds inte.
UnsupportedDynamicConfiguration

string

Dynamisk konfiguration som inte stöds.
UnsupportedFilter

string

Filter som inte stöds.
UnsupportedLanguageCode

string

Språkkod som inte stöds.
UnsupportedOrderBy

string

Beställningen stöds inte av.
UnsupportedPagination

string

Sidnumrering stöds inte.
UnsupportedTimeRange

string

Tidsintervallet stöds inte.

EntityError

EntityError

Name Typ Description
code

string

Koden för det här felet.
message

string

Meddelandet för det här felet.

EntityReference

EntityReference

Name Typ Description
self

string

Platsen för den refererade entiteten.

Error

Fel

Name Typ Description
code

ErrorCode

Felkod
Felkoder på hög nivå.
details

Error[]

Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller de obligatoriska egenskaperna ErrorCode, message och optional properties target, details(key value pair), inner error(this can be nested).
message

string

Felmeddelande på hög nivå.
target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

ErrorCode

Felkod

Name Typ Description
Conflict

string

Representerar konfliktfelkoden.
Forbidden

string

Representerar den förbjudna felkoden.
InternalCommunicationFailed

string

Representerar felkoden för den interna kommunikationen misslyckades.
InternalServerError

string

Representerar den interna felkoden för servern.
InvalidArgument

string

Representerar den ogiltiga argumentfelkoden.
InvalidRequest

string

Representerar den ogiltiga felkoden för begäran.
NotAllowed

string

Representerar den felkod som inte tillåts.
NotFound

string

Representerar felkoden hittades inte.
PipelineError

string

Representerar felkoden för pipelinefel.
ServiceUnavailable

string

Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests

string

Representerar felkoden för för många begäranden.
Unauthorized

string

Representerar den obehöriga felkoden.
UnprocessableEntity

string

Representerar felkoden för entiteten som inte kan bearbetas.
UnsupportedMediaType

string

Representerar felkoden för medietypen som inte stöds.

InnerError

InnerError

Name Typ Description
code

DetailedErrorCode

DetailedErrorCode
Detaljerad felkodsuppräkning.
details

object

Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller de obligatoriska egenskaperna ErrorCode, message och optional properties target, details(key value pair), inner error(this can be nested).
message

string

Felmeddelande på hög nivå.
target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

OutputFormatType

OutputFormatType

Name Typ Description
Display

string

Modellen stöder utdata eller slutpunkter för transkriptioner av visningsformat.
Lexical

string

Modellen tillhandahåller transkriptionsutdata utan formatering.

PaginatedCustomModels

SidnumreradeCustomModels

Name Typ Description
@nextLink

string

En länk till nästa uppsättning sidnumrerade resultat om det finns fler tillgängliga entiteter. annars null.
values

CustomModel[]

En lista över entiteter som begränsas av antingen de skickade frågeparametrarna "skip" och "top" eller deras standardvärden.

När du itererar genom en lista med sidnumrering och tar bort entiteter parallellt hoppas vissa entiteter över i resultatet. Vi rekommenderar att du skapar en lista på klienten och tar bort efter hämtningen av den fullständiga listan.

Status

Status

Name Typ Description
Failed

string

Den långvariga åtgärden misslyckades.
NotStarted

string

Den långvariga åtgärden har ännu inte startats.
Running

string

Den tidskrävande åtgärden bearbetas för närvarande.
Succeeded

string

Den långvariga åtgärden har slutförts.