Endpoints - Create

Referens

Tjänst:: Azure AI Services

API-version:: v3.2-preview.2

Skapar en ny slutpunkt.

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

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

Begärandetext

Name	Obligatorisk	Typ	Description
displayName	True	string minLength: 1	Objektets visningsnamn.
locale	True	string minLength: 1	Nationella inställningar för inneslutna data.
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.
description		string	Beskrivningen av objektet.
model		EntityReference	EntityReference
project		EntityReference	EntityReference
properties		EndpointProperties	EndpointProperties
text		string	Texten som används för att anpassa en språkmodell för den här slutpunkten.

Svar

Name	Typ	Description
201 Created	Endpoint	Svaret innehåller information om entiteten som nyttolast och dess plats som rubrik. Sidhuvuden Location: string
Other Status Codes	Error	Ett fel uppstod.

Name

Typ

Description

201 Created

Endpoint

Svaret innehåller information om entiteten som nyttolast och dess plats som rubrik.

Sidhuvuden

Location: string

Other Status Codes

Error

Ett fel uppstod.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Typ: apiKey
I: header

Authorization

Ange en åtkomsttoken från 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

Create an endpoint

Exempelbegäran

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"
}

Exempelsvar

Statuskod:: 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"
}

Definitioner

Name	Description
DetailedErrorCode	DetailedErrorCode
Endpoint	Slutpunkt
EndpointLinks	Slutpunktlänkar
EndpointProperties	EndpointProperties
EntityError	EntityError
EntityReference	EntityReference
Error	Fel
ErrorCode	Felkod
InnerError	InnerError
Status	Status

DetailedErrorCode

Uppräkning

DetailedErrorCode

Värde	Description
DataImportFailed	Dataimporten misslyckades.
DeleteNotAllowed	Ta bort tillåts inte.
DeployNotAllowed	Distribution tillåts inte.
DeployingFailedModel	Distribution av en misslyckad modell.
EmptyRequest	Tom begäran.
EndpointCannotBeDefault	Slutpunkten kan inte vara standard.
EndpointNotUpdatable	Slutpunkten kan inte uppdateras.
EndpointWithoutLogging	Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris	Överskred antalet inspelningar uris.
FailedDataset	Datauppsättningen misslyckades.
Forbidden	Förbjuden.
InUseViolation	Vid användningsöverträdelse.
InaccessibleCustomerStorage	Otillgänglig kundlagring.
InvalidAdaptationMapping	Ogiltig anpassningsmappning.
InvalidBaseModel	Ogiltig basmodell.
InvalidCallbackUri	Ogiltig återanrops-URI.
InvalidCollection	Ogiltig samling.
InvalidDataset	Ogiltig datauppsättning.
InvalidDocument	Ogiltigt dokument.
InvalidDocumentBatch	Ogiltig dokumentbatch.
InvalidLocale	Ogiltigt språk.
InvalidLogDate	Ogiltigt loggdatum.
InvalidLogEndTime	Ogiltig loggsluttid.
InvalidLogId	Ogiltigt logg-ID.
InvalidLogStartTime	Ogiltig starttid för loggen.
InvalidModel	Ogiltig modell.
InvalidModelUri	Ogiltig modell-URI.
InvalidParameter	Ogiltig parameter.
InvalidParameterValue	Ogiltigt parametervärde.
InvalidPayload	Ogiltig nyttolast.
InvalidPermissions	Ogiltiga behörigheter.
InvalidPrerequisite	Ogiltigt krav.
InvalidProductId	Ogiltigt produkt-ID.
InvalidProject	Ogiltigt projekt.
InvalidProjectKind	Ogiltig projekttyp.
InvalidRecordingsUri	Ogiltig inspelnings-URI.
InvalidRequestBodyFormat	Ogiltigt brödtextformat för begäran.
InvalidSasValidityDuration	Ogiltig varaktighet för sas-giltighet.
InvalidSkipTokenForLogs	Ogiltig hopptoken för loggar.
InvalidSourceAzureResourceId	Ogiltigt azure-källresurs-ID.
InvalidSubscription	Ogiltig prenumeration.
InvalidTest	Ogiltigt test.
InvalidTimeToLive	Ogiltig tid att leva.
InvalidTopForLogs	Ogiltig topp för loggar.
InvalidTranscription	Ogiltig transkription.
InvalidWebHookEventKind	Ogiltig typ av webbhookhändelse.
MissingInputRecords	Indataposter saknas.
ModelCopyOperationExists	Modellkopieringsåtgärden finns.
ModelDeploymentNotCompleteState	Modelldistributionen har inte slutförts.
ModelDeprecated	Modellen är inaktuell.
ModelExists	Modellen finns.
ModelMismatch	Modellmatchningsfel.
ModelNotDeployable	Modellen kan inte distribueras.
ModelVersionIncorrect	Modellversionen är felaktig.
NoUtf8WithBom	Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset	Endast en av url:erna eller containern eller datamängden.
ProjectGenderMismatch	Matchningsfel för projektkön.
QuotaViolation	Kvotöverträdelse.
SingleDefaultEndpoint	Enskild standardslutpunkt.
SkuLimitsExist	Det finns SKU-gränser.
SubscriptionNotFound	Det går inte att hitta prenumerationen.
UnexpectedError	Oväntat fel.
UnsupportedClassBasedAdaptation	Klassbaserad anpassning som inte stöds.
UnsupportedDelta	Delta stöds inte.
UnsupportedDynamicConfiguration	Dynamisk konfiguration stöds inte.
UnsupportedFilter	Filter som inte stöds.
UnsupportedLanguageCode	Språkkod som inte stöds.
UnsupportedOrderBy	Order som inte stöds av.
UnsupportedPagination	Sidnumrering stöds inte.
UnsupportedTimeRange	Tidsintervall som inte stöds.

Endpoint

Objekt

Slutpunkt

Name	Typ	Description
createdDateTime	string (date-time)	Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-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.
description	string	Beskrivningen av objektet.
displayName	string minLength: 1	Objektets visningsnamn.
lastActionDateTime	string (date-time)	Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln är kodad som ISO 8601-datum- och tidsformat ("ÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	EndpointLinks	Slutpunktlänkar
locale	string minLength: 1	Nationella inställningar för inneslutna data.
model	EntityReference	EntityReference
project	EntityReference	EntityReference
properties	EndpointProperties	EndpointProperties
self	string (uri)	Platsen för den här entiteten.
status	Status	Status Beskriva api:ets aktuella tillstånd
text	string	Texten som används för att anpassa en språkmodell för den här slutpunkten.

EndpointLinks

Objekt

Slutpunktlänkar

Name	Typ	Description
logs	string (uri)	Ljud- och transkriptionsloggarna för den här slutpunkten. Mer information finns i åtgärden "Endpoints_ListLogs".
restConversation	string (uri)	REST-slutpunkten för begäranden upp till 60 sekunder.
restDictation	string (uri)	REST-slutpunkten för begäranden upp till 60 sekunder, vilket stöder diktering av skiljetecken.
restInteractive	string (uri)	REST-slutpunkten för korta begäranden upp till 15 sekunder.
webSocketConversation	string (uri)	Speech SDK-slutpunkten för långa begäranden med flera slutliga resultat.
webSocketDictation	string (uri)	Speech SDK-slutpunkten för långa begäranden med flera slutliga resultat, med stöd för diktering av skiljetecken.
webSocketInteractive	string (uri)	Speech SDK-slutpunkten för korta begäranden upp till 15 sekunder med ett enda slutligt resultat.

EndpointProperties

Objekt

EndpointProperties

Name	Typ	Description
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
loggingEnabled	boolean	Ett värde som anger om innehållsloggning (ljud & transkriptioner) används för en distribution.
timeToLive	string	Hur länge slutpunkten ska behållas i systemet. När slutpunkten når tiden till live efter slutförandet (lyckades eller misslyckades) tas den bort automatiskt. Om du inte anger det här värdet eller inställningen till 0 inaktiveras automatisk borttagning. Den längsta varaktigheten som stöds är 31 dagar. Varaktigheten kodas som ISO 8601-varaktighet ("PnYnMnDTnHnMnS", se https://en.wikipedia.org/wiki/ISO_8601#Durations).

EntityError

Objekt

EntityError

Name	Typ	Description
code	string	Koden för det här felet.
message	string	Meddelandet för det här felet.

EntityReference

Objekt

EntityReference

Name	Typ	Description
self	string (uri)	Platsen för den refererade entiteten.

Error

Objekt

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 nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel värde par), inre fel (detta kan kapslas).
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

Uppräkning

Felkod

Värde	Description
Conflict	Representerar konfliktfelkoden.
Forbidden	Representerar den otillåtna felkoden.
InternalCommunicationFailed	Det gick inte att ange felkoden för intern kommunikation.
InternalServerError	Representerar felkoden för den interna servern.
InvalidArgument	Representerar den ogiltiga argumentfelkoden.
InvalidRequest	Representerar den ogiltiga felkoden för begäran.
NotAllowed	Representerar den felkod som inte tillåts.
NotFound	Representerar felkoden som inte hittades.
PipelineError	Representerar felkoden för pipelinefel.
ServiceUnavailable	Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests	Representerar felkoden för för många begäranden.
Unauthorized	Representerar den obehöriga felkoden.
UnprocessableEntity	Representerar felkoden för entitetsfel som inte kan bearbetas.
UnsupportedMediaType	Representerar felkoden för medietypen som inte stöds.

InnerError

Objekt

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 nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckel värde par), inre fel (detta kan kapslas).
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.

Status

Uppräkning

Status

Värde	Description
Failed	Den tidskrävande åtgärden misslyckades.
NotStarted	Den tidskrävande åtgärden har ännu inte startats.
Running	Den tidskrävande åtgärden bearbetas för närvarande.
Succeeded	Den tidskrävande åtgärden har slutförts.

Dela via

Endpoints - Create

URI-parametrar

Begärandetext

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Authorization

Exempel

Create an endpoint

Exempelbegäran

Exempelsvar

Definitioner

DetailedErrorCode

Endpoint

EndpointLinks

EndpointProperties

EntityError

EntityReference

Error

ErrorCode

InnerError

Status

Ytterligare resurser