Condividi tramite


Endpoints - Resume

Riprende l'endpoint identificato dall'ID specificato.

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
endpoint
path True

string

Endpoint di Servizi cognitivi supportati (protocollo e nome host, ad esempio: https://eastus.api.cognitive.microsoft.com).

id
path True

string (uuid)

ID risorsa, che deve essere UUID.

api-version
query True

string

minLength: 1

Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome Necessario Tipo Descrizione
Ocp-Apim-Subscription-Key True

string

Specificare la chiave della risorsa Voce qui.

Operation-Id

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

ID del monitoraggio dello stato per l'operazione. Se l'intestazione Operation-Id corrisponde a un'operazione esistente e la richiesta non è identica alla richiesta precedente, avrà esito negativo con una richiesta 400 non valida.

Risposte

Nome Tipo Descrizione
202 Accepted

Endpoint

Accettato

Intestazioni

  • Operation-Id: string
  • Operation-Location: string
Other Status Codes

ErrorResponse

Si è verificato un errore.

Intestazioni

x-ms-error-code: string

Sicurezza

Ocp-Apim-Subscription-Key

Specificare la chiave della risorsa Voce qui.

Tipo: apiKey
In: header

Esempio

Resume an endpoint

Esempio di richiesta

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


Risposta di esempio

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

Definizioni

Nome Descrizione
Endpoint

Oggetto endpoint

EndpointKind

Tipo di endpoint

EndpointProperties

Proprietà dell'endpoint

Error

L'errore di primo livello segue le linee guida dell'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.

ErrorCode

Codice di errore di primo livello

ErrorResponse

La risposta di errore segue le linee guida dell'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

InnerError

L'errore interno segue le linee guida dell'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà necessarie, la destinazione del messaggio e le proprietà facoltative, l'errore interno (che può essere annidato).

Status

Stato di una risorsa.

Endpoint

Oggetto endpoint

Nome Tipo Descrizione
createdDateTime

string (date-time)

Timestamp di creazione dell'oggetto. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

description

string

Descrizione dell'endpoint

displayName

string

minLength: 1

Nome endpoint

id

string (uuid)

Endpoint Id

lastActionDateTime

string (date-time)

Timestamp quando è stato immesso lo stato corrente. Il timestamp viene codificato come formato di data e ora ISO 8601 ("AAAA-MM-GGThh:mm:ssZ", vedere 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]$

ID risorsa

projectId

string

minLength: 3
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$

ID risorsa

properties

EndpointProperties

Proprietà dell'endpoint

status

Status

Stato di una risorsa.

EndpointKind

Tipo di endpoint

Valore Descrizione
FastResume
HighPerformance

EndpointProperties

Proprietà dell'endpoint

Nome Tipo Descrizione
kind

EndpointKind

Tipo di endpoint

Error

L'errore di primo livello segue le linee guida dell'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.

Nome Tipo Descrizione
code

ErrorCode

Codice di errore di primo livello

details

Error[]

Ulteriori dettagli di supporto relativi all'errore e/o ai criteri previsti.

innererror

InnerError

L'errore interno segue le linee guida dell'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà necessarie, la destinazione del messaggio e le proprietà facoltative, l'errore interno (che può essere annidato).

message

string

Messaggio di errore di primo livello.

target

string

Origine dell'errore. Ad esempio, sarebbe "model" o "model id" in caso di modello non valido.

ErrorCode

Codice di errore di primo livello

Valore Descrizione
BadArgument
BadRequest
Forbidden
InternalServerError
NotFound
ServiceUnavailable
TooManyRequests
Unauthorized
UnsupportedMediaType

ErrorResponse

La risposta di errore segue le linee guida dell'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome Tipo Descrizione
error

Error

L'errore di primo livello segue le linee guida dell'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene un errore di primo livello con codice di errore, messaggio, dettagli, destinazione e errore interno con dettagli più descrittivi.

InnerError

L'errore interno segue le linee guida dell'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà necessarie, la destinazione del messaggio e le proprietà facoltative, l'errore interno (che può essere annidato).

Nome Tipo Descrizione
code

string

Codice di errore dettagliato per facilitare la diagnostica.

innererror

InnerError

L'errore interno segue le linee guida dell'API REST di Microsoft Azure disponibili in https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors. Contiene il codice di errore delle proprietà necessarie, la destinazione del messaggio e le proprietà facoltative, l'errore interno (che può essere annidato).

message

string

Messaggio di errore dettagliato.

target

string

Origine dell'errore. Ad esempio, sarebbe "model" o "model id" in caso di modello non valido.

Status

Stato di una risorsa.

Valore Descrizione
Disabled
Disabling
Failed
NotStarted
Running
Succeeded