Reference documentation and code samples for the Google Cloud Ces V1 Client class Example.
An example represents a sample conversation between the user and the agent(s).
Generated from protobuf message google.cloud.ces.v1.Example
Namespace
Google \ Cloud \ Ces \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
string
Identifier. The unique identifier of the example. Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
↳ display_name
string
Required. Display name of the example.
↳ description
string
Optional. Human-readable description of the example.
↳ entry_agent
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
↳ create_time
↳ update_time
↳ 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
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.
getName
Identifier. The unique identifier of the example.
Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
string
setName
Identifier. The unique identifier of the example.
Format: projects/{project}/locations/{location}/apps/{app}/examples/{example}
var
string
$this
getDisplayName
Required. Display name of the example.
string
setDisplayName
Required. Display name of the example.
var
string
$this
getDescription
Optional. Human-readable description of the example.
string
setDescription
Optional. Human-readable description of the example.
var
string
$this
getEntryAgent
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}
string
setEntryAgent
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}
var
string
$this
getMessages
Optional. The collection of messages that make up the conversation.
setMessages
Optional. The collection of messages that make up the conversation.
$this
getCreateTime
Output only. Timestamp when the example was created.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when the example was created.
$this
getUpdateTime
Output only. Timestamp when the example was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when the example was last updated.
$this
getInvalid
Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
bool
setInvalid
Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
var
bool
$this
getEtag
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.
string
setEtag
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.
var
string
$this
