Endpoints - Resume

Referens

Tjänst:: Azure AI Services

API-version:: 2024-02-01-preview

Återupptar slutpunkten som identifieras av det angivna ID:t.

POST {endpoint}/customvoice/endpoints/{id}:resume?api-version=2024-02-01-preview

URI-parametrar

Name	I	Obligatorisk	Typ	Description
endpoint	path	True	string	Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://eastus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	Resurs-ID:t, som ska vara UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string	Ange din Speech-resursnyckel här.
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID för statusövervakaren för åtgärden. Om Operation-Id-huvudet matchar en befintlig åtgärd och begäran inte är identisk med den tidigare begäran misslyckas den med en 400 Felaktig begäran.

Svar

Name	Typ	Description
202 Accepted	Endpoint	Accepterad Sidhuvuden Operation-Id: string Operation-Location: string
Other Status Codes	ErrorResponse	Ett fel uppstod. Sidhuvuden x-ms-error-code: string

Name

Typ

Description

202 Accepted

Endpoint

Accepterad

Sidhuvuden

Operation-Id: string
Operation-Location: string

Other Status Codes

ErrorResponse

Ett fel uppstod.

Sidhuvuden

x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Ange din Speech-resursnyckel här.

Typ: apiKey
I: header

Exempel

Resume an endpoint

Exempelbegäran

HTTP

POST {endpoint}/customvoice/endpoints/9f50c644-2121-40e9-9ea7-544e48bfe3cb:resume?api-version=2024-02-01-preview

Exempelsvar

Statuskod:: 202

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/15cc4e23-3cc7-4811-adcc-75e5804765cc?api-version=2024-02-01-preview
Operation-Id: 15cc4e23-3cc7-4811-adcc-75e5804765cc

{
  "id": "9f50c644-2121-40e9-9ea7-544e48bfe3cb",
  "description": "Endpoint for Jessica voice",
  "projectId": "Jessica",
  "modelId": "Jessica",
  "properties": {
    "kind": "HighPerformance"
  },
  "status": "Running",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z"
}

Definitioner

Name	Description
Endpoint	Slutpunktsobjekt
EndpointKind	Typ av slutpunkt
EndpointProperties	Slutpunktsegenskaper
Error	Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.
ErrorCode	Felkod på toppnivå
ErrorResponse	Felsvaret följer riktlinjerna för Microsoft Azure REST API som är tillgängliga på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
InnerError	Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
Status	Status för en resurs.

Endpoint

Objekt

Slutpunktsobjekt

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).
description	string	Beskrivning av slutpunkt
displayName	string minLength: 1	Slutpunktsnamn
id	string (uuid)	Slutpunkts-ID
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).
modelId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resurs-ID
properties	EndpointProperties	Slutpunktsegenskaper
status	Status	Status för en resurs.

EndpointKind

Uppräkning

Typ av slutpunkt

Värde	Description
FastResume
HighPerformance

EndpointProperties

Objekt

Slutpunktsegenskaper

Name	Typ	Description
kind	EndpointKind	Typ av slutpunkt

Error

Objekt

Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

Name	Typ	Description
code	ErrorCode	Felkod på toppnivå
details	Error[]	Ytterligare stödjande information om fel och/eller förväntade principer.
innererror	InnerError	Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Felmeddelande på den översta nivån.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" i händelse av en ogiltig modell.

ErrorCode

Uppräkning

Felkod på toppnivå

Värde	Description
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

Objekt

Felsvaret följer riktlinjerna för Microsoft Azure REST API som är tillgängliga på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Typ	Description
error	Error	Fel på toppnivå följer Riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller ett fel på den översta nivån med felkod, meddelande, information, mål och ett inre fel med mer beskrivande information.

InnerError

Objekt

Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).

Name	Typ	Description
code	string	Detaljerad felkod för diagnostik.
innererror	InnerError	Inre fel följer riktlinjerna för Microsoft Azure REST API som finns på https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Detta innehåller nödvändig egenskapsfelkod, meddelande och valfritt egenskapsmål, inre fel (detta kan kapslas).
message	string	Detaljerat felmeddelande.
target	string	Källan till felet. Det skulle till exempel vara "modell" eller "modell-ID" i händelse av en ogiltig modell.

Status

Uppräkning

Status för en resurs.

Värde	Description
Disabled
Disabling
Failed
NotStarted
Running
Succeeded

Dela via

Endpoints - Resume

URI-parametrar

Begärandehuvud

Svar

Säkerhet

Ocp-Apim-Subscription-Key

Exempel

Resume an endpoint

Exempelbegäran

Exempelsvar

Definitioner

Endpoint

EndpointKind

EndpointProperties

Error

ErrorCode

ErrorResponse

InnerError

Status

Ytterligare resurser