Gemini Enterprise for Customer Experience v1 API - Class Example (1.0.0-beta01) 

public sealed class Example : IMessage<Example>, IEquatable<Example>, IDeepCloneable<Example>, IBufferMessage, IMessage

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1 API class Example.

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

Inheritance

object > Example

Namespace

Google.Cloud.Ces.V1

Assembly

Google.Cloud.Ces.V1.dll

Constructors

Example()

public Example()

Example(Example)

public Example(Example other)
Parameter
Name Description
other Example

Properties

CreateTime

public Timestamp CreateTime { get; set; }

Output only. Timestamp when the example was created.

Property Value
Type Description
Timestamp

Description

public string Description { get; set; }

Optional. Human-readable description of the example.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Required. Display name of the example.

Property Value
Type Description
string

EntryAgent

public string EntryAgent { get; set; }

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}

Property Value
Type Description
string

EntryAgentAsAgentName

public AgentName EntryAgentAsAgentName { get; set; }

AgentName-typed view over the EntryAgent resource name property.

Property Value
Type Description
AgentName

Etag

public string Etag { get; set; }

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.

Property Value
Type Description
string

ExampleName

public ExampleName ExampleName { get; set; }

ExampleName-typed view over the Name resource name property.

Property Value
Type Description
ExampleName

Invalid

public bool Invalid { get; set; }

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

Property Value
Type Description
bool

Messages

public RepeatedField<Message> Messages { get; }

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

Property Value
Type Description
RepeatedFieldMessage

Name

public string Name { get; set; }

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

Property Value
Type Description
string

UpdateTime

public Timestamp UpdateTime { get; set; }

Output only. Timestamp when the example was last updated.

Property Value
Type Description
Timestamp