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

Resource: Session

External session proto definition.

JSON representation 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "startTime": string,
  "endTime": string
}
Fields
name

string

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
state

enum (State)

The state of the session.
userPseudoId

string

A unique identifier for tracking users.
turns[]

object (Turn)

Turns.
startTime

string (Timestamp format)

Output only. The time the session started.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
endTime

string (Timestamp format)

Output only. The time the session finished.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

State

Enumeration of the state of the session.

Enums
STATE_UNSPECIFIED State is unspecified.
IN_PROGRESS The session is currently open.

Turn

Represents a turn, including a query from the user and a answer from service.

JSON representation 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "detailedAnswer": {
    object (Answer)
  }
}
Fields
query

object (Query)

The user query.
answer

string

The resource name of the answer to the user query.

Only set if the answer generation (/answer API call) happened in this turn.
detailedAnswer

object (Answer)

Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.

Query

Defines a user inputed query.

JSON representation 
{
  "queryId": string,

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

string

Unique Id for the query.
Union field content. Query content. content can be only one of the following:
text

string

Plain text.

Methods

create

 Creates a Session.

delete

 Deletes a Session.

get

 Gets a Session.

list

 Lists all Sessions by their parent DataStore.

patch

 Updates a Session.