VoiceAgentProtocolError class

Paket:
@azure/ai-projects

Ett fel uppstår när ett WebSocket-meddelande inte stämmer överens med röstagentprotokollet.

Extends
VoiceAgentRealtimeError

Konstruktorer

VoiceAgentProtocolError(string, { cause?: unknown })

Ärvda egenskaper

cause

Det underliggande felet, när det finns.
code

En stabil kod som identifierar felkategorin.
message
name
stack
stackTraceLimit

Egenskapen Error.stackTraceLimit anger antalet stackramar som samlas in av en stackspårning (oavsett om den genereras av new Error().stack eller Error.captureStackTrace(obj)).

Standardvärdet är 10 men kan ställas in på valfritt giltigt JavaScript-nummer. Ändringarna påverkar alla stackspårningar som samlas in efter att värdet har ändrats.

Om det är inställt på ett icke-numeriskt värde, eller inställt på ett negativt tal, kommer stackspårningar inte att samla in några bildrutor.

Ärvda metoder

captureStackTrace(object, Function)

Skapar en .stack egenskap på targetObject, som när den används returnerar en sträng som representerar platsen i koden som Error.captureStackTrace() anropades.

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

Den första raden i spårningen föregås ${myObject.name}: ${myObject.message}av .

Det valfria constructorOpt argumentet accepterar en funktion. Om det anges utelämnas alla bildrutor ovanför constructorOpt, inklusive constructorOpt, från den genererade stackspårningen.

Argumentet constructorOpt är användbart för att dölja implementeringsinformation för felgenerering från användaren. Till exempel:

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[])

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

Konstruktorinformation

VoiceAgentProtocolError(string, { cause?: unknown }) 

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

Parametrar

message

string

options

{ cause?: unknown }

Information om ärvda egenskaper

cause

Det underliggande felet, när det finns.

cause?: unknown

Egenskapsvärde

unknown

Ärvt frånVoiceAgentRealtimeError.cause

code

En stabil kod som identifierar felkategorin.

code: VoiceAgentRealtimeErrorCode

Egenskapsvärde

VoiceAgentRealtimeErrorCode

Ärvd frånVoiceAgentRealtimeError.code

message 

message: string

Egenskapsvärde

string

Ärvt frånVoiceAgentRealtimeError.message

name 

name: string

Egenskapsvärde

string

Ärvt frånVoiceAgentRealtimeError.name

stack 

stack?: string

Egenskapsvärde

string

Ärvd frånVoiceAgentRealtimeError.stack

stackTraceLimit

Egenskapen Error.stackTraceLimit anger antalet stackramar som samlas in av en stackspårning (oavsett om den genereras av new Error().stack eller Error.captureStackTrace(obj)).

Standardvärdet är 10 men kan ställas in på valfritt giltigt JavaScript-nummer. Ändringarna påverkar alla stackspårningar som samlas in efter att värdet har ändrats.

Om det är inställt på ett icke-numeriskt värde, eller inställt på ett negativt tal, kommer stackspårningar inte att samla in några bildrutor.

static stackTraceLimit: number

Egenskapsvärde

number

Ärvd frånVoiceAgentRealtimeError.stackTraceLimit

Ärvd metodinformation

captureStackTrace(object, Function)

Skapar en .stack egenskap på targetObject, som när den används returnerar en sträng som representerar platsen i koden som Error.captureStackTrace() anropades.

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

Den första raden i spårningen föregås ${myObject.name}: ${myObject.message}av .

Det valfria constructorOpt argumentet accepterar en funktion. Om det anges utelämnas alla bildrutor ovanför constructorOpt, inklusive constructorOpt, från den genererade stackspårningen.

Argumentet constructorOpt är användbart för att dölja implementeringsinformation för felgenerering från användaren. Till exempel:

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)

Parametrar

targetObject

object

constructorOpt

Function

Ärvd frånVoiceAgentRealtimeError.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parametrar

err

Error

stackTraces

CallSite[]

Returer

any

Ärvd frånVoiceAgentRealtimeError.prepareStackTrace