REST Resource: projects.locations.apps.examples

Resource: Example

An example represents a sample conversation between the user and the agent(s).

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "entryAgent": string,
  "messages": [
    {
      object (Message)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "invalid": boolean,
  "etag": string
}
Fields
name

string

Identifier. The unique identifier of the example. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
displayName

string

Required. Display name of the example.
description

string

Optional. Human-readable description of the example.
entryAgent

string

Optional. The agent that initially handles the conversation. If not specified, the example represents a conversation that is handled by the root agent. Format: projects/{project}/locations/{location}/apps/{app}/agents/{agent}
messages[]

object (Message)

Optional. The collection of messages that make up the conversation.
createTime

string (Timestamp format)

Output only. Timestamp when the example 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. Timestamp when the example 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".
invalid

boolean

Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
etag

string

Etag used to ensure the object hasn't changed during a read-modify-write operation. If the etag is empty, the update will overwrite any concurrent changes.

Methods

create

 Creates a new example in the given app.

delete

 Deletes the specified example.

get

 Gets details of the specified example.

list

 Lists examples in the given app.

patch

 Updates the specified example.