REST Resource: projects.locations.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

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

メソッド

create

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

delete

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

get

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

list

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

patch

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