View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaSession (google_api_discovery_engine v0.27.0)

External session proto definition.

Attributes

  • displayName (type: String.t, default: nil) - Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session.
  • endTime (type: DateTime.t, default: nil) - Output only. The time the session finished.
  • isPinned (type: boolean(), default: nil) - Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list.
  • name (type: String.t, default: nil) - Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
  • startTime (type: DateTime.t, default: nil) - Output only. The time the session started.
  • state (type: String.t, default: nil) - The state of the session.
  • turns (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaSessionTurn.t), default: nil) - Turns.
  • userPseudoId (type: String.t, default: nil) - A unique identifier for tracking users.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaSession{
    displayName: String.t() | nil,
    endTime: DateTime.t() | nil,
    isPinned: boolean() | nil,
    name: String.t() | nil,
    startTime: DateTime.t() | nil,
    state: String.t() | nil,
    turns:
      [
        GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1alphaSessionTurn.t()
      ]
      | nil,
    userPseudoId: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.