REST Resource: projects.locations.collections.dataStores.sessions

リソース: セッション

外部セッションの proto 定義。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
フィールド
name

string

変更不可。完全修飾名 projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

省略可。セッションの表示名。

このフィールドは、UI でセッションを識別するために使用されます。デフォルトでは、表示名はセッションの最初のターンのクエリテキストです。
state

enum (State)

セッションの状態。
userPseudoId

string

ユーザーをトラッキングするための一意の識別子。
turns[]

object (Turn)

ターン。
labels[]

string

省略可。セッションのラベル。ListSessionsRequest でフィルタとして設定できます。
startTime

string (Timestamp format)

出力専用。セッションの開始時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
endTime

string (Timestamp format)

出力専用。セッションが終了した時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
isPinned

boolean

省略可。セッションが固定されているかどうか。固定されているセッションはセッション リストの上部に表示されます。

状態

セッションの状態の列挙。

列挙型
STATE_UNSPECIFIED 状態が指定されていません。
IN_PROGRESS セッションは現在オープンです。

Turn

ユーザーからのクエリやサービスからの回答など、ターンを表します。

JSON 表現 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  }
}
フィールド
query

object (Query)

省略可。ユーザーのクエリ。このターンが別のターンの回答を再生成しているだけの場合は設定されないことがあります
answer

string

省略可。ユーザー クエリに対する回答のリソース名。

このターンで回答生成（/answer API 呼び出し）が行われた場合にのみ設定します。
assistAnswer

string

出力専用。ユーザーのクエリに対するアシスタントの回答のリソース名。

このターンでアシスト呼び出し（/assist API 呼び出し）が発生した場合にのみ設定されます。

形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}。セッションのすべての AssistAnswer を取得するには、GetSessionRequest.include_answer_details を true に設定します。または、個々の AssistAnswer リソースを取得するには、AssistAnswerService.GetAssistAnswer API を使用します。
detailedAnswer

object (Answer)

出力専用。ConversationalSearchService.GetSession API で GetSessionRequest.include_answer_details が true に設定されている場合、回答クエリ セッションを取得するときにこのフィールドが入力されます。
detailedAssistAnswer

object (AssistAnswer)

出力専用。ConversationalSearchService.GetSession API で GetSessionRequest.include_answer_details が true に設定されている場合、アシスタント セッションを取得するときにこのフィールドが入力されます。
queryConfig

map (key: string, value: string)

省略可。クエリ構成に関連するメタデータ（使用された LLM モデルとバージョン、モデル パラメータ（温度、グラウンディング パラメータなど））を表します。接頭辞「google.」は、Google が開発した機能用に予約されています。

クエリ

ユーザーが入力したクエリを定義します。

JSON 表現 
{
  "queryId": string,

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
フィールド
queryId

string

出力専用。クエリの一意の ID。
共用体フィールド content。コンテンツをクエリします。content は次のいずれかになります。
text

string

書式なしテキスト。

メソッド

create

 セッションを作成します。

delete

 セッションを削除します。

get

 セッションを取得します。

list

 親 DataStore ごとにすべてのセッションを一覧表示します。

patch

 セッションを更新します。