SessionConfig

セッションの構成。

JSON 表現
{
  "session": string,
  "inputAudioConfig": {
    object (InputAudioConfig)
  },
  "outputAudioConfig": {
    object (OutputAudioConfig)
  },
  "historicalContexts": [
    {
      object (Message)
    }
  ],
  "entryAgent": string,
  "deployment": string,
  "timeZone": string,
  "useToolFakes": boolean,
  "remoteDialogflowQueryParameters": {
    object (SessionConfig.RemoteDialogflowQueryParameters)
  },
  "enableTextStreaming": boolean,
  "excludeDiagnosticInfo": boolean
}
フィールド
session

string

必須。セッションの固有識別子。形式: projects/{project}/locations/{location}/apps/{app}/sessions/{session}

inputAudioConfig

object (InputAudioConfig)

省略可。入力音声の処理の構成。

outputAudioConfig

object (OutputAudioConfig)

省略可。出力音声の生成に関する構成。

historicalContexts[]

object (Message)

省略可。セッションの履歴コンテキスト(ユーザー入力、エージェントの応答、その他のメッセージなど)。通常、CES エージェントはセッションを自動的に管理するため、クライアントがこのフィールドに明示的に値を入力する必要はありません。ただし、クライアントは必要に応じて履歴コンテキストをオーバーライドして、特定の状態からセッションを強制的に開始できます。

entryAgent

string

省略可。セッションに対応する最初のエージェント。指定しない場合、セッションはアプリの root agent によって処理されます。形式: projects/{project}/locations/{location}/apps/{app}/agents/{agent}

deployment

string

省略可。セッションで使用するアプリのデプロイ。形式: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}

timeZone

string

省略可。ユーザーのタイムゾーン。指定すると、エージェントは日付と時刻に関連する変数にこのタイムゾーンを使用します。それ以外の場合、エージェントは App.time_zone_settings で指定されたタイムゾーンを使用します。

形式は IANA タイムゾーン データベースのタイムゾーンです(例: America/Los_Angeles)。

useToolFakes

boolean

省略可。セッションでツール フェイクを使用するかどうか。このフィールドが設定されている場合、エージェントは実際のツールを呼び出す代わりに、ツール フェイクを使用しようとします。

remoteDialogflowQueryParameters

object (SessionConfig.RemoteDialogflowQueryParameters)

省略可。セッション制御がリモート エージェントに転送されたときにリモート Dialogflow エージェントに送信する QueryParameters

enableTextStreaming

boolean

省略可。モデルからのテキスト出力のストリーミングを有効にするかどうか。デフォルトでは、モデルからのテキスト出力は収集されてからクライアントに送信されます。注: これは、StreamRunSession または BidiRunSession を介したテキスト(音声以外)セッションでのみサポートされています。

excludeDiagnosticInfo

boolean

省略可。セッション出力から診断情報を除外するかどうか。

InputAudioConfig

InputAudioConfig は、CES エージェントが受信した音声データを解釈する方法を構成します。

JSON 表現
{
  "audioEncoding": enum (AudioEncoding),
  "sampleRateHertz": integer,
  "noiseSuppressionLevel": string
}
フィールド
audioEncoding

enum (AudioEncoding)

必須。入力音声データのエンコード。

sampleRateHertz

integer

必須。入力音声データのサンプルレート(ヘルツ単位)。

noiseSuppressionLevel

string

省略可。入力音声のノイズ サプレッションを有効にするかどうか。使用可能な値は、「low」、「moderate」、「high」、「very_high」です。

AudioEncoding

AudioEncoding は、音声データのエンコード形式を指定します。

列挙型
AUDIO_ENCODING_UNSPECIFIED 音声エンコードが指定されていません。
LINEAR16 16 ビット リニア PCM オーディオ エンコード。
MULAW G.711 PCMU/mu-law を使用して 14 ビットの音声サンプルの圧縮と伸張を行う 8 ビットのサンプル。
ALAW G.711 PCMU/A-law を使用して 14 ビットの音声サンプルの圧縮と伸張を行う 8 ビットのサンプル。

OutputAudioConfig

OutputAudioConfig は、CES エージェントが発信音声レスポンスを合成する方法を構成します。

JSON 表現
{
  "audioEncoding": enum (AudioEncoding),
  "sampleRateHertz": integer
}
フィールド
audioEncoding

enum (AudioEncoding)

必須。出力音声データのエンコード。

sampleRateHertz

integer

必須。出力音声データのサンプリング レート(ヘルツ単位)。

SessionConfig.RemoteDialogflowQueryParameters

セッション制御がリモート エージェントに転送されたときにリモート Dialogflow エージェントに送信する QueryParameters

JSON 表現
{
  "webhookHeaders": {
    string: string,
    ...
  },
  "payload": {
    object
  },
  "endUserMetadata": {
    object
  }
}
フィールド
webhookHeaders

map (key: string, value: string)

省略可。QueryParameters の webhookHeaders として送信される HTTP ヘッダー。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

payload

object (Struct format)

省略可。QueryParameters で送信されるペイロード。

endUserMetadata

object (Struct format)

省略可。QueryParameters で送信されるエンドユーザーのメタデータ。