Method: projects.locations.brands.sessionRecords.list

特定のブランドの SessionRecord を一覧表示します。

HTTP リクエスト

GET https://foodorderingaiagent.googleapis.com/v1beta/{parent=projects/*/locations/*/brands/*}/sessionRecords

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

パスパラメータ

パラメータ
parent

string

必須。注文セッションを一覧表示するブランド。形式: projects/{project}/locations/{location}/brands/{brand}

クエリ パラメータ

パラメータ
pageSize

integer

省略可。返すセッション レコードの最大数。サービスが返す値はこれよりも少ないことがあります。指定されていない場合、最大で 50 個のセッションが返されます。最大値は 1,000 です。1,000 を超える値は 1,000 に強制変換されます。
pageToken

string

省略可。前回の sessionRecords.list 呼び出しから受け取ったページトークン。後続のページを取得するにはこれを指定します。
filter

string

省略可。AIP-160 に基づくフィルタ式。このフィールドでは、さまざまな属性に基づいてセッション レコードをフィルタできます。

サポートされているフィルタ フィールド:

  • session_id（文字列）: セッションの ID。演算子: = 例: session_id = "session-123"

  • storeId（文字列）: ストアの ID。演算子: =, != 例: storeId = "store-123"

  • sessionStartTime（タイムスタンプ）: セッションの開始時間。タイムスタンプには、RFC-3339 形式の文字列（例: 2012-04-21T11:30:00-04:00）を指定します。UTC オフセットがサポートされています。演算子: =, !=,

    、>=、<、<= 例: sessionStartTime >= "2025-10-01T00:00:00Z"

  • outcomeLabel（文字列）: セッションの最終結果ラベル。演算子: =, != 例: outcomeLabel = "SUCCESS"

  • outcomeGroupLabel（String）: セッションの結果のグループ ラベル。演算子: =, != 例: outcomeGroupLabel = "SUCCESS"

  • predictedFailureCategory（String）: 介入分析から得られたセッションの予測障害カテゴリ。演算子: =, != 例: predictedFailureCategory = "Menu"

  • agent_utterances（文字列）: エージェントが発話したテキスト。演算子: :（トークン/全文検索）例: agent_utterances:"anything else"

  • user_utterances（文字列）: ユーザーが発話したテキスト。演算子: :（トークン/全文検索）例: user_utterances:"burger"

論理演算子:

条件は、AND、OR、NOT を使用して組み合わせることができます。かっこ () を使用して式をグループ化し、評価の順序を制御できます。例: (user_utterances:"help" OR agent_utterances:"issue") AND storeId != "test-store" 例: user_utterances:"order" AND sessionStartTime >= "2025-10-03T00:00:00Z"

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

[SessionRecordService.ListSessionRecords][] のレスポンス メッセージ。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "sessionRecords": [
    {
      object (SessionRecord)
    }
  ],
  "nextPageToken": string
}
フィールド
sessionRecords[]

object (SessionRecord)

セッション レコードのリスト。
nextPageToken

string

次のページを取得するために pageToken として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

認可スコープ

次の OAuth スコープが必要です。

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

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