VoiceAgentProtocolError class

Pacote:
@azure/ai-projects

Um erro gerado quando uma mensagem WebSocket não corresponde ao protocolo do agente de voz.

Extends
VoiceAgentRealtimeError

Construtores

VoiceAgentProtocolError(string, { cause?: unknown })

Propriedades herdadas

cause

O erro subjacente, quando disponível.
code

Um código estável identificando a categoria de erro.
message
name
stack
stackTraceLimit

A Error.stackTraceLimit propriedade especifica o número de quadros de pilha coletados por um rastreamento de pilha (gerado por new Error().stack ou Error.captureStackTrace(obj)).

O valor padrão é 10 but pode ser definido como qualquer número JavaScript válido. As alterações afetarão qualquer rastreamento de pilha capturado após a alteração do valor.

Se definido como um valor diferente do número ou definido como um número negativo, os rastreamentos de pilha não capturarão nenhum quadro.

Métodos herdados

captureStackTrace(object, Function)

Cria uma .stack propriedade em targetObject, que, quando acessada, retorna uma cadeia de caracteres que representa o local no código no qual Error.captureStackTrace() foi chamado.

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

A primeira linha do traço será prefixada com ${myObject.name}: ${myObject.message}.

O argumento opcional constructorOpt aceita uma função. Se fornecido, todos os quadros acima constructorOpt, incluindo constructorOpt, serão omitidos do rastreamento de pilha gerado.

O constructorOpt argumento é útil para ocultar detalhes de implementação da geração de erros do usuário. Por exemplo:

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

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

Detalhes do construtor

VoiceAgentProtocolError(string, { cause?: unknown }) 

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

Parâmetros

message

string

options

{ cause?: unknown }

Detalhes das propriedades herdadas

cause

O erro subjacente, quando disponível.

cause?: unknown

Valor da propriedade

unknown

Herdado deVoiceAgentRealtimeError.cause

code

Um código estável identificando a categoria de erro.

code: VoiceAgentRealtimeErrorCode

Valor da propriedade

VoiceAgentRealtimeErrorCode

Herdado deVoiceAgentRealtimeError.code

message 

message: string

Valor da propriedade

string

Herdado deVoiceAgentRealtimeError.message

name 

name: string

Valor da propriedade

string

Herdado deVoiceAgentRealtimeError.name

stack 

stack?: string

Valor da propriedade

string

Herdado doVoiceAgentRealtimeError.stack

stackTraceLimit

A Error.stackTraceLimit propriedade especifica o número de quadros de pilha coletados por um rastreamento de pilha (gerado por new Error().stack ou Error.captureStackTrace(obj)).

O valor padrão é 10 but pode ser definido como qualquer número JavaScript válido. As alterações afetarão qualquer rastreamento de pilha capturado após a alteração do valor.

Se definido como um valor diferente do número ou definido como um número negativo, os rastreamentos de pilha não capturarão nenhum quadro.

static stackTraceLimit: number

Valor da propriedade

number

Herdado deVoiceAgentRealtimeError.stackTraceLimit

Detalhes do método herdado

captureStackTrace(object, Function)

Cria uma .stack propriedade em targetObject, que, quando acessada, retorna uma cadeia de caracteres que representa o local no código no qual Error.captureStackTrace() foi chamado.

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

A primeira linha do traço será prefixada com ${myObject.name}: ${myObject.message}.

O argumento opcional constructorOpt aceita uma função. Se fornecido, todos os quadros acima constructorOpt, incluindo constructorOpt, serão omitidos do rastreamento de pilha gerado.

O constructorOpt argumento é útil para ocultar detalhes de implementação da geração de erros do usuário. Por exemplo:

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)

Parâmetros

targetObject

object

constructorOpt

Function

Herdado deVoiceAgentRealtimeError.captureStackTrace

prepareStackTrace(Error, CallSite[])

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

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

Parâmetros

err

Error

stackTraces

CallSite[]

Retornos

any

Herdado deVoiceAgentRealtimeError.prepareStackTrace