SessionSearchResult

Session matching a search query in SessionService.SearchSessions.

JSON representation
{
  "session": string,
  "sessionDisplayName": string,
  "matchedTurns": [
    {
      object (TurnResult)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "starred": boolean
}
Fields
session

string

The session resource name. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engineId}/sessions/{sessionId}

sessionDisplayName

string

Output only. Display name of the session.

matchedTurns[]

object (TurnResult)

Output only. The turns within the session that matched the query. May be empty.

createTime

string (Timestamp format)

Output only. The time when the session was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The time when the session was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

starred

boolean

Output only. Whether the session is starred by the user.

TurnResult

A turn within a session that matched the query.

JSON representation
{
  "turnId": string,
  "textContent": string,
  "snippets": [
    {
      object (Snippet)
    }
  ]
}
Fields
turnId

string

Output only. Unique id of the turn that matched.

textContent

string

Output only. The full text content of the turn.

snippets[]

object (Snippet)

Output only. The snippet(s) of the turn that matched the query. May be absent.

Snippet

Represents a snippet of text from a turn, with highlight ranges. For full-text search, the snippet text will a portion of the matched text within which the highlight ranges are specified. For semantic search, the snippet text will be the complete chunk from the turn that matched the search query.

JSON representation
{
  "snippetText": string,
  "highlights": [
    {
      object (Highlight)
    }
  ],
  "matchType": enum (SessionSearchMatchType)
}
Fields
snippetText

string

Output only. The text of the snippet.

highlights[]

object (Highlight)

Output only. The highlights within the snippet matching the query. May be empty.

matchType

enum (SessionSearchMatchType)

Output only. The type of match for the snippet.

Highlight

Represents a range of text within a string. Indices are 1-based and inclusive, so for example if the snippet text is "Google Cloud Storage", startIndex is 18, and endIndex is 22, the highlighted text is "Cloud". For full-text search, the highglight will be the matched text. For semantic search, the highlight may be the full text of the chunk, a subsequence of the chunk if a semantic match can be performed, or it may be absent altogether.

JSON representation
{
  "startIndex": integer,
  "endIndex": integer
}
Fields
startIndex

integer

Output only. The index of the first character of the highlight, inclusive.

endIndex

integer

Output only. The index of the last character of the highlight, inclusive.