Google Cloud Dialogflow V2 Client - Class AnalyzeContentRequest (1.11.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class AnalyzeContentRequest.

The request message for Participants.AnalyzeContent.

Generated from protobuf message google.cloud.dialogflow.v2.AnalyzeContentRequest

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ participant`	`string` Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`.
`↳ text_input`	`Google\Cloud\Dialogflow\V2\TextInput` The natural language text to be processed.
`↳ event_input`	`Google\Cloud\Dialogflow\V2\EventInput` An input event to send to Dialogflow.
`↳ suggestion_input`	`Google\Cloud\Dialogflow\V2\SuggestionInput` An input representing the selection of a suggestion.
`↳ reply_audio_config`	`Google\Cloud\Dialogflow\V2\OutputAudioConfig` Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.
`↳ query_params`	`Google\Cloud\Dialogflow\V2\QueryParameters` Parameters for a Dialogflow virtual-agent query.
`↳ assist_query_params`	`Google\Cloud\Dialogflow\V2\AssistQueryParameters` Parameters for a human assist query.
`↳ cx_parameters`	`Google\Protobuf\Struct` Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null. Note: this field should only be used if you are connecting to a Dialogflow CX agent.
`↳ request_id`	`string` A unique identifier for this request. Restricted to 36 ASCII characters. A random UUID is recommended. This request is only idempotent if a `request_id` is provided.

getParticipant

Required. The name of the participant this text comes from.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Returns
Type	Description
`string`

setParticipant

Required. The name of the participant this text comes from.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getTextInput

The natural language text to be processed.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\TextInput\|null`

hasTextInput

setTextInput

The natural language text to be processed.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\V2\TextInput`

Returns
Type	Description
`$this`

getEventInput

An input event to send to Dialogflow.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\EventInput\|null`

hasEventInput

setEventInput

An input event to send to Dialogflow.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\V2\EventInput`

Returns
Type	Description
`$this`

getSuggestionInput

An input representing the selection of a suggestion.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\SuggestionInput\|null`

hasSuggestionInput

setSuggestionInput

An input representing the selection of a suggestion.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\V2\SuggestionInput`

Returns
Type	Description
`$this`

getReplyAudioConfig

Speech synthesis configuration.

The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling AnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\OutputAudioConfig\|null`

hasReplyAudioConfig

clearReplyAudioConfig

setReplyAudioConfig

Speech synthesis configuration.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\V2\OutputAudioConfig`

Returns
Type	Description
`$this`

getQueryParams

Parameters for a Dialogflow virtual-agent query.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\QueryParameters\|null`

hasQueryParams

clearQueryParams

setQueryParams

Parameters for a Dialogflow virtual-agent query.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\V2\QueryParameters`

Returns
Type	Description
`$this`

getAssistQueryParams

Parameters for a human assist query.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\AssistQueryParameters\|null`

hasAssistQueryParams

clearAssistQueryParams

setAssistQueryParams

Parameters for a human assist query.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\V2\AssistQueryParameters`

Returns
Type	Description
`$this`

getCxParameters

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

Returns
Type	Description
`Google\Protobuf\Struct\|null`

hasCxParameters

clearCxParameters

setCxParameters

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

Parameter
Name	Description
`var`	`Google\Protobuf\Struct`

Returns
Type	Description
`$this`

getRequestId

A unique identifier for this request. Restricted to 36 ASCII characters.

A random UUID is recommended. This request is only idempotent if a request_id is provided.

Returns
Type	Description
`string`

setRequestId

A unique identifier for this request. Restricted to 36 ASCII characters.

A random UUID is recommended. This request is only idempotent if a request_id is provided.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInput

Returns
Type	Description
`string`

static::build

Parameters
Name	Description
`participant`	`string` Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`. Please see Google\Cloud\Dialogflow\V2\ParticipantsClient::participantName() for help formatting this field.
`textInput`	`Google\Cloud\Dialogflow\V2\TextInput` The natural language text to be processed.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\AnalyzeContentRequest`

static::buildFromParticipantEventInput

Parameters
Name	Description
`participant`	`string` Required. The name of the participant this text comes from. Format: `projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>`. Please see Google\Cloud\Dialogflow\V2\ParticipantsClient::participantName() for help formatting this field.
`eventInput`	`Google\Cloud\Dialogflow\V2\EventInput` An input event to send to Dialogflow.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\AnalyzeContentRequest`