VoiceAgentProtocolError class

パッケージ:
@azure/ai-projects

WebSocketメッセージが音声エージェントプロトコルと一致しない場合にエラーが発生します。

Extends
VoiceAgentRealtimeError

コンストラクター

VoiceAgentProtocolError(string, { cause?: unknown })

継承されたプロパティ

cause

利用可能な場合は、その根本的な誤差です。
code

エラーカテゴリを識別する安定コード。
message
name
stack
stackTraceLimit

Error.stackTraceLimit プロパティは、スタック トレースによって収集されるスタック フレームの数を指定します (new Error().stack によって生成されたか、Error.captureStackTrace(obj)によって生成されたかは問いません)。

デフォルト値は 10 ですが、任意の有効な JavaScript 番号に設定できます。 変更は、値の変更 後に キャプチャされたスタック・トレースに影響します。

数値以外の値に設定した場合、または負の数に設定した場合、スタックトレースはフレームをキャプチャしません。

継承されたメソッド

captureStackTrace(object, Function)

.stack に targetObject プロパティを作成します。このプロパティにアクセスすると、Error.captureStackTrace() が呼び出されたコード内の場所を表す文字列が返されます。

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

トレースの最初の行には、接頭辞 ${myObject.name}: ${myObject.message} が付きます。

オプションの constructorOpt 引数は関数を受け入れます。 指定した場合、constructorOpt を含む constructorOpt より上のすべてのフレームは、生成されたスタック トレースから省略されます。

constructorOpt引数は、エラー生成の実装の詳細をユーザーから隠すのに役立ちます。 次に例を示します。

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

「https://v8.dev/docs/stack-trace-api#customizing-stack-traces」を参照してください。

コンストラクターの詳細

VoiceAgentProtocolError(string, { cause?: unknown }) 

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

パラメーター

message

string

options

{ cause?: unknown }

継承されたプロパティの詳細

cause

利用可能な場合は、その根本的な誤差です。

cause?: unknown

プロパティ値

unknown

VoiceAgentRealtimeError.causeから引き継ぎました

code

エラーカテゴリを識別する安定コード。

code: VoiceAgentRealtimeErrorCode

プロパティ値

VoiceAgentRealtimeErrorCode

VoiceAgentRealtimeError.codeから引き継いだものです

message 

message: string

プロパティ値

string

VoiceAgentRealtimeError.messageから継承

name 

name: string

プロパティ値

string

VoiceAgentRealtimeError.nameから受け継いだもの

stack 

stack?: string

プロパティ値

string

VoiceAgentRealtimeError.stackから継承

stackTraceLimit

Error.stackTraceLimit プロパティは、スタック トレースによって収集されるスタック フレームの数を指定します (new Error().stack によって生成されたか、Error.captureStackTrace(obj)によって生成されたかは問いません)。

デフォルト値は 10 ですが、任意の有効な JavaScript 番号に設定できます。 変更は、値の変更 後に キャプチャされたスタック・トレースに影響します。

数値以外の値に設定した場合、または負の数に設定した場合、スタックトレースはフレームをキャプチャしません。

static stackTraceLimit: number

プロパティ値

number

VoiceAgentRealtimeError.stackTraceLimitから継承

継承済みメソッドの詳細

captureStackTrace(object, Function)

.stack に targetObject プロパティを作成します。このプロパティにアクセスすると、Error.captureStackTrace() が呼び出されたコード内の場所を表す文字列が返されます。

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

トレースの最初の行には、接頭辞 ${myObject.name}: ${myObject.message} が付きます。

オプションの constructorOpt 引数は関数を受け入れます。 指定した場合、constructorOpt を含む constructorOpt より上のすべてのフレームは、生成されたスタック トレースから省略されます。

constructorOpt引数は、エラー生成の実装の詳細をユーザーから隠すのに役立ちます。 次に例を示します。

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)

パラメーター

targetObject

object

constructorOpt

Function

VoiceAgentRealtimeError.captureStackTraceから継承

prepareStackTrace(Error, CallSite[])

「https://v8.dev/docs/stack-trace-api#customizing-stack-traces」を参照してください。

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

パラメーター

err

Error

stackTraces

CallSite[]

返品

any

VoiceAgentRealtimeError.prepareStackTraceから継承