Endpoints - Create

Service:: Azure AI Services

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

Hiermee maakt u een nieuw eindpunt.

POST {endpoint}/speechtotext/v3.2-preview.2/endpoints

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

Aanvraagbody

Name	Vereist	Type	Description
displayName	True	string minLength: 1	De weergavenaam van het object.
locale	True	string minLength: 1	De landinstelling van de ingesloten gegevens.
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.
model		EntityReference	EntityReference
project		EntityReference	EntityReference
properties		EndpointProperties	EndpointProperties
text		string	De tekst die wordt gebruikt om een taalmodel voor dit eindpunt aan te passen.

Antwoorden

Name	Type	Description
201 Created	Endpoint	Het antwoord bevat informatie over de entiteit als nettolading en de locatie als header. Kopteksten Location: string
Other Status Codes	Error	Er is een fout opgetreden.

Name

Type

Description

201 Created

Endpoint

Het antwoord bevat informatie over de entiteit als nettolading en de locatie als header.

Kopteksten

Location: string

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

Create an endpoint

Voorbeeldaanvraag

HTTP

POST {
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "loggingEnabled": true
  },
  "locale": "en-US",
  "displayName": "Speech endpoint definition",
  "description": "This is a speech endpoint"
}/speechtotext/v3.2-preview.2/endpoints

{
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "loggingEnabled": true
  },
  "locale": "en-US",
  "displayName": "Speech endpoint definition",
  "description": "This is a speech endpoint"
}

Voorbeeldrespons

Statuscode:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6",
  "model": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "links": {
    "logs": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/afa0669c-a01e-4693-ae3a-93baf40f26d6/files/logs",
    "restInteractive": "https://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restConversation": "https://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "restDictation": "https://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketInteractive": "wss://westus.stt.speech.microsoft.com/speech/recognition/interactive/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketConversation": "wss://westus.stt.speech.microsoft.com/speech/recognition/conversation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6",
    "webSocketDictation": "wss://westus.stt.speech.microsoft.com/speech/recognition/dictation/cognitiveservices/v1?cid=afa0669c-a01e-4693-ae3a-93baf40f26d6"
  },
  "properties": {
    "timeToLive": "PT30M",
    "loggingEnabled": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Speech endpoint",
  "description": "Example for speech endpoint"
}

Definities

Name	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	Eindpunt
EndpointLinks	EndpointLinks
EndpointProperties	EndpointProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Fout
ErrorCode	ErrorCode
InnerError	InnerError
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.
InvalidSourceAzureResourceId	Ongeldige azure-bronresource-id.
ModelCopyOperationExists	Er bestaat een modelkopiebewerking.

Endpoint

Object

Eindpunt

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.
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	EndpointLinks	EndpointLinks
locale	string minLength: 1	De landinstelling van de ingesloten gegevens.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
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 een taalmodel voor dit eindpunt aan te passen.

EndpointLinks

Object

EndpointLinks

Name	Type	Description
logs	string (uri)	De audio- en transcriptielogboeken voor dit eindpunt. Zie de bewerking 'Endpoints_ListLogs' voor meer informatie.
restConversation	string (uri)	Het REST-eindpunt voor aanvragen tot 60 seconden.
restDictation	string (uri)	Het REST-eindpunt voor aanvragen tot 60 seconden, met ondersteuning voor het dicteren van leestekens.
restInteractive	string (uri)	Het REST-eindpunt voor korte aanvragen tot 15 seconden.
webSocketConversation	string (uri)	Het Speech SDK-eindpunt voor lange aanvragen met meerdere eindresultaten.
webSocketDictation	string (uri)	Het Speech SDK-eindpunt voor lange aanvragen met meerdere eindresultaten, met ondersteuning voor het dicteren van leestekens.
webSocketInteractive	string (uri)	Het Speech SDK-eindpunt voor korte aanvragen tot 15 seconden met één eindresultaat.

EndpointProperties

Object

EndpointProperties

Name	Type	Description
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
loggingEnabled	boolean	Een waarde die aangeeft of de logboekregistratie van inhoud (audio & transcripties) wordt gebruikt voor een implementatie.
timeToLive	string	Hoe lang het eindpunt in het systeem wordt bewaard. Zodra het eindpunt de time to live heeft bereikt na voltooiing (geslaagd of mislukt), wordt het automatisch verwijderd. Als u deze waarde niet instelt op 0, wordt automatisch verwijderen uitgeschakeld. De langste ondersteunde duur is 31 dagen. De duur wordt gecodeerd als ISO 8601-duur ('PnYnMnDTnHnMnS', zie https://en.wikipedia.org/wiki/ISO_8601#Durations).

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.

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.

Delen via

Endpoints - Create

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Authorization

Voorbeelden

Create an endpoint

Voorbeeldaanvraag

Voorbeeldrespons

Definities

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

Status