Method: projects.locations.apps.sessions.runSession

セッション内で CES エージェントとのシングルターン インタラクションを開始します。

HTTP リクエスト

POST https://ces.googleapis.com/v1beta/{config.session=projects/*/locations/*/apps/*/sessions/*}:runSession

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
config.session

string

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

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "config": {
    "session": string,
    "inputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer,
      "noiseSuppressionLevel": string
    },
    "outputAudioConfig": {
      "audioEncoding": enum (AudioEncoding),
      "sampleRateHertz": integer
    },
    "historicalContexts": [
      {
        "role": string,
        "chunks": [
          {
            object (Chunk)
          }
        ],
        "eventTime": string
      }
    ],
    "entryAgent": string,
    "deployment": string,
    "timeZone": string,
    "useToolFakes": boolean,
    "remoteDialogflowQueryParameters": {
      "webhookHeaders": {
        string: string,
        ...
      },
      "payload": {
        object
      },
      "endUserMetadata": {
        object
      }
    },
    "enableTextStreaming": boolean,
    "includeLlmThoughtSummary": boolean,
    "excludeDiagnosticInfo": boolean,
    "includeProgressUpdate": boolean
  },
  "inputs": [
    {
      object (SessionInput)
    }
  ]
}
フィールド
config.inputAudioConfig

object (InputAudioConfig)

省略可。入力音声を処理するための構成。
config.outputAudioConfig

object (OutputAudioConfig)

省略可。出力音声を生成するための構成。
config.historicalContexts[]

object (Message)

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

string

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

string

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

string

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

形式は IANA タイムゾーン データベースのタイムゾーン（例: America/Los_Angeles）です。
config.useToolFakes

boolean

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

object (SessionConfig.RemoteDialogflowQueryParameters)

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

boolean

省略可。モデルからのテキスト出力を、生成された時点でクライアントに段階的にストリーミングするかどうか。デフォルトは false です。

  • 無効にすると、モデルのテキスト出力がバッファリングされ、クライアントに送信される各テキスト出力は完全な文になります。クライアントは、各テキスト出力を新しい行にレンダリングできます。
  • 有効にすると、各テキスト出力に文の一部のみが含まれる場合があります。クライアントは、連続するテキスト出力を連結して、完全なレスポンスをレンダリングする必要があります。

注: これは、sessions.streamRunSession または BidiRunSession を使用したテキスト（音声以外）セッションでのみサポートされています。
config.includeLlmThoughtSummary

boolean

省略可。セッション出力に LLM の思考の要約を含めるかどうか。
config.excludeDiagnosticInfo

boolean

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

boolean

省略可。クライアントに中間処理の更新を含めるかどうか。有効にすると、更新は SessionOutput.progress で返されます。
inputs[]

object (SessionInput)

必須。セッションの入力。

レスポンスの本文

成功した場合、レスポンスの本文には RunSessionResponse のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

詳細については、Authentication Overview をご覧ください。

IAM 権限

session リソースに対する次の IAM 権限が必要です。

  • ces.sessions.runSession

詳細については、IAM のドキュメントをご覧ください。