Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class Parameter.
Represents an intent parameter.
Generated from protobuf message google.cloud.dialogflow.cx.v3.Intent.Parameter
Namespace
Google \ Cloud \ Dialogflow \ Cx \ V3 \ IntentMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ id |
string
Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts. |
↳ entity_type |
string
Required. The entity type of the parameter. Format: |
↳ is_list |
bool
Indicates whether the parameter represents a list of values. |
↳ redact |
bool
Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging. Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled. |
getId
Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
| Returns | |
|---|---|
| Type | Description |
string |
|
setId
Required. The unique identifier of the parameter. This field is used by training phrases to annotate their parts.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEntityType
Required. The entity type of the parameter.
Format:
projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID> for
system entity types (for example,
projects/-/locations/-/agents/-/entityTypes/sys.date), or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>
for developer entity types.
| Returns | |
|---|---|
| Type | Description |
string |
|
setEntityType
Required. The entity type of the parameter.
Format:
projects/-/locations/-/agents/-/entityTypes/<SystemEntityTypeID> for
system entity types (for example,
projects/-/locations/-/agents/-/entityTypes/sys.date), or
projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/entityTypes/<EntityTypeID>
for developer entity types.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsList
Indicates whether the parameter represents a list of values.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsList
Indicates whether the parameter represents a list of values.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRedact
Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging.
Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setRedact
Indicates whether the parameter content should be redacted in log. If redaction is enabled, the parameter content will be replaced by parameter name during logging.
Note: the parameter content is subject to redaction if either parameter level redaction or entity type level redaction is enabled.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|