Example

import type { Example } from "https://googleapis.deno.dev/v1/ces:v1.ts";

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

interface Example {

readonly createTime?: Date;

description?: string;

displayName?: string;

entryAgent?: string;

etag?: string;

readonly invalid?: boolean;

messages?: Message[];

name?: string;

readonly updateTime?: Date;

}

§Properties

readonly createTime?: Date

[src]

Output only. Timestamp when the example was created.

description?: string

[src]

Optional. Human-readable description of the example.

displayName?: string

[src]

Required. Display name of the example.

entryAgent?: string

[src]

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}

etag?: string

[src]

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.

readonly invalid?: boolean

[src]

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

messages?: Message[]

[src]

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

name?: string

[src]

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

readonly updateTime?: Date

[src]

Output only. Timestamp when the example was last updated.