VoiceAgentProtocolError class

Package:
@azure/ai-projects

Une erreur est générée lorsqu’un message WebSocket ne correspond pas au protocole de l’agent vocal.

Extends
VoiceAgentRealtimeError

Constructeurs

VoiceAgentProtocolError(string, { cause?: unknown })

Propriétés héritées

cause

L’erreur sous-jacente, quand elle est disponible.
code

Un code stable identifiant la catégorie d’erreur.
message
name
stack
stackTraceLimit

La Error.stackTraceLimit propriété spécifie le nombre de trames de pile collectées par une trace de pile (qu’elle soit générée par new Error().stack ou Error.captureStackTrace(obj)).

La valeur par défaut est 10 mais peut être définie sur n’importe quel numéro JavaScript valide. Les modifications affecteront toute trace de pile capturée après la modification de la valeur.

S’ils sont définis sur une valeur non numérique ou sur un nombre négatif, les traces de pile ne captureront aucune trame.

Méthodes héritées

captureStackTrace(object, Function)

Crée une .stack propriété le , targetObjectqui, lorsqu’elle est accédée, renvoie une chaîne représentant l’emplacement dans le code auquel Error.captureStackTrace() a été appelé.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

La première ligne de la trace sera préfixée par ${myObject.name}: ${myObject.message}.

L’argument facultatif constructorOpt accepte une fonction. Si cette option est donnée, toutes les images au-dessus constructorOptde , y compris constructorOpt, seront omises de la trace de pile générée.

L’argument constructorOpt est utile pour masquer à l’utilisateur les détails de l’implémentation de la génération d’erreurs. Exemple :

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
prepareStackTrace(Error, CallSite[])

Voir https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Détails du constructeur

VoiceAgentProtocolError(string, { cause?: unknown }) 

new VoiceAgentProtocolError(message: string, options?: { cause?: unknown })

Paramètres

message

string

options

{ cause?: unknown }

Détails de la propriété héritée

cause

L’erreur sous-jacente, quand elle est disponible.

cause?: unknown

Valeur de propriété

unknown

Hérité deVoiceAgentRealtimeError.cause

code

Un code stable identifiant la catégorie d’erreur.

code: VoiceAgentRealtimeErrorCode

Valeur de propriété

VoiceAgentRealtimeErrorCode

Hérité deVoiceAgentRealtimeError.code

message 

message: string

Valeur de propriété

string

Hérité deVoiceAgentRealtimeError.message

name 

name: string

Valeur de propriété

string

Héritée deVoiceAgentRealtimeError.name

stack 

stack?: string

Valeur de propriété

string

Hérité deVoiceAgentRealtimeError.stack

stackTraceLimit

La Error.stackTraceLimit propriété spécifie le nombre de trames de pile collectées par une trace de pile (qu’elle soit générée par new Error().stack ou Error.captureStackTrace(obj)).

La valeur par défaut est 10 mais peut être définie sur n’importe quel numéro JavaScript valide. Les modifications affecteront toute trace de pile capturée après la modification de la valeur.

S’ils sont définis sur une valeur non numérique ou sur un nombre négatif, les traces de pile ne captureront aucune trame.

static stackTraceLimit: number

Valeur de propriété

number

Hérité deVoiceAgentRealtimeError.stackTraceLimit

Détails de la méthode héritée

captureStackTrace(object, Function)

Crée une .stack propriété le , targetObjectqui, lorsqu’elle est accédée, renvoie une chaîne représentant l’emplacement dans le code auquel Error.captureStackTrace() a été appelé.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

La première ligne de la trace sera préfixée par ${myObject.name}: ${myObject.message}.

L’argument facultatif constructorOpt accepte une fonction. Si cette option est donnée, toutes les images au-dessus constructorOptde , y compris constructorOpt, seront omises de la trace de pile générée.

L’argument constructorOpt est utile pour masquer à l’utilisateur les détails de l’implémentation de la génération d’erreurs. Exemple :

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

static function captureStackTrace(targetObject: object, constructorOpt?: Function)

Paramètres

targetObject

object

constructorOpt

Function

Hérité deVoiceAgentRealtimeError.captureStackTrace

prepareStackTrace(Error, CallSite[])

Voir https://v8.dev/docs/stack-trace-api#customizing-stack-traces

static function prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Paramètres

err

Error

stackTraces

CallSite[]

Retours

any

Hérité deVoiceAgentRealtimeError.prepareStackTrace