REST Resource: projects.locations.conversations

Resource: Conversation

Message for a conversation.

JSON representation
{
  "name": string,
  "agents": [
    string
  ],
  "createTime": string,
  "lastUsedTime": string,
  "labels": {
    string: string,
    ...
  }
}
Fields
name

string

Optional. Identifier. The unique resource name of a conversation. Format: projects/{project}/locations/{location}/conversations/{conversationId} {conversationId} is the resource id and should be 63 characters or less and must match the format described in https://google.aip.dev/122#resource-id-segments

Example: projects/1234567890/locations/us-central1/conversations/my-conversation.

It is recommended to skip setting this field during conversation creation as it will be inferred automatically and overwritten with the {parent}/conversations/{conversationId}.

agents[]

string

Required. Agent(s) in the conversation. Currently, only one agent is supported. This field is repeated to allow for future support of multiple agents in a conversation. Format: projects/{project}/locations/{location}/dataAgents/{agent}

createTime

string (Timestamp format)

Output only. Creation timestamp.

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".

lastUsedTime

string (Timestamp format)

Output only. Timestamp of the last used conversation.

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".

labels

map (key: string, value: string)

Optional. Open-ended and user-defined labels that can be set by the client to tag a conversation (e.g. to filter conversations for specific surfaces/products).

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Methods

create

Creates a new conversation to persist the conversation history.

get

Gets details of a single conversation by using conversation id and parent.

list

Lists all conversations for a given parent.