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.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The unique identifier of the example. Format: |
↳ 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: |
↳ messages |
array<Message>
Optional. The collection of messages that make up the conversation. |
↳ create_time |
Google\Protobuf\Timestamp
Output only. Timestamp when the example was created. |
↳ update_time |
Google\Protobuf\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 |
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}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. The unique identifier of the example.
Format:
projects/{project}/locations/{location}/apps/{app}/examples/{example}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayName
Required. Display name of the example.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDisplayName
Required. Display name of the example.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
Optional. Human-readable description of the example.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDescription
Optional. Human-readable description of the example.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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}
| Returns | |
|---|---|
| Type | Description |
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}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMessages
Optional. The collection of messages that make up the conversation.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<Message> |
|
setMessages
Optional. The collection of messages that make up the conversation.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Message>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCreateTime
Output only. Timestamp when the example was created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp when the example was created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. Timestamp when the example was last updated.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp when the example was last updated.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInvalid
Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setInvalid
Output only. The example may become invalid if referencing resources are deleted. Invalid examples will not be used as few-shot examples.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|