Class Example (0.3.0)

Example(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

Attributes

Name Description
name str
Identifier. The unique identifier of the example. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
display_name str
Required. Display name of the example.
description str
Optional. Human-readable description of the example.
entry_agent str
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 MutableSequence[google.cloud.ces_v1beta.types.Message]
Optional. The collection of messages that make up the conversation.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the example was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when the example was last updated.
invalid bool
Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
etag str
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.