Delen via


Models - Get Base Model

Hiermee haalt u het basismodel op dat wordt geïdentificeerd door de opgegeven id.

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

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 basismodel.

Antwoorden

Name Type Description
200 OK

BaseModel

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 a base model

Voorbeeldaanvraag

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b

Voorbeeldrespons

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "deprecationDates": {
      "adaptationDateTime": "2022-11-04T00:00:00Z",
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": true,
      "supportsAdaptationsWith": [
        "Language",
        "Acoustic"
      ],
      "supportedOutputFormats": [
        "Display",
        "Lexical"
      ]
    },
    "chargeForAdaptation": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "en-US Base model"
}

Definities

Name Description
BaseModel

Basismodel

BaseModelDeprecationDates

BaseModelDeprecationDates

BaseModelFeatures

BaseModelFeatures

BaseModelLinks

BaseModelLinks

BaseModelProperties

BaseModelProperties

DatasetKind

DatasetKind

DetailedErrorCode

DetailedErrorCode

Error

Fout

ErrorCode

ErrorCode

InnerError

InnerError

OutputFormatType

OutputFormatType

Status

Toestand

BaseModel

Basismodel

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

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

BaseModelLinks

BaseModelLinks

locale

string

minLength: 1

De landinstelling van de ingesloten gegevens.

properties

BaseModelProperties

BaseModelProperties

self

string (uri)

De locatie van deze entiteit.

status

Status

Toestand
De huidige status van de API beschrijven

BaseModelDeprecationDates

BaseModelDeprecationDates

Name Type Description
adaptationDateTime

string (date-time)

De datum waarop aanpassing wordt afgeschaft.

transcriptionDateTime

string (date-time)

De datum waarop transcriptie wordt afgeschaft.

BaseModelFeatures

BaseModelFeatures

Name Type Description
supportedOutputFormats

OutputFormatType[]

Ondersteunde uitvoerindelingen.

supportsAdaptationsWith

DatasetKind[]

Ondersteunde gegevenssettypen om het model aan te passen.

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.

BaseModelLinks

Name Type Description
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.

BaseModelProperties

BaseModelProperties

Name Type Description
chargeForAdaptation

boolean

Een waarde die aangeeft of modelaanpassing wordt in rekening gebracht.

deprecationDates

BaseModelDeprecationDates

BaseModelDeprecationDates

features

BaseModelFeatures

BaseModelFeatures
Functies die worden ondersteund door het model.

DatasetKind

DatasetKind

Waarde Description
Acoustic

Een akoestische gegevensset.

AudioFiles

Een gegevensset met audiobestanden.

Language

Een taalgegevensset.

LanguageMarkdown

Een markdown-gegevensset voor taal.

OutputFormatting

Gegevensset met regels voor het aanpassen van inverse tekstnormalisatie, hoofdlettergebruik, herformulering, grof taalgebruik en definieert ook tests voor gegevenssetvalidatie

Pronunciation

Een uitspraakgegevensset.

DetailedErrorCode

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.

Error

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

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

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

OutputFormatType

Waarde Description
Display

Model ondersteunt weergavetranscriptiesuitvoer of eindpunten.

Lexical

Model biedt de transcriptieuitvoer zonder opmaak.

Status

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.