Google Cloud Dialogflow V2 Client - Class SearchKnowledgeRequest (1.12.3)

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

The request message for Conversations.SearchKnowledge .

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

Namespace

Google \ Cloud \ Dialogflow \ V2

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

The parent resource contains the conversation profile Format: 'projects/

↳ query
Google\Cloud\Dialogflow\V2\TextInput

Required. The natural language text query for knowledge search.

↳ conversation_profile
string

Required. The conversation profile used to configure the search. Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID> .

↳ session_id
string

The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate Session ID . It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.

↳ conversation
string

The conversation (between human agent and end user) where the search request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID> .

↳ latest_message
string

The name of the latest conversation message when the request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID> .

getParent

The parent resource contains the conversation profile Format: 'projects/

Returns
Type
Description
string

setParent

The parent resource contains the conversation profile Format: 'projects/

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getQuery

Required. The natural language text query for knowledge search.

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

hasQuery

clearQuery

setQuery

Required. The natural language text query for knowledge search.

Parameter
Name
Description
var
Google\Cloud\Dialogflow\V2\TextInput
Returns
Type
Description
$this

getConversationProfile

Required. The conversation profile used to configure the search.

Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID> .

Returns
Type
Description
string

setConversationProfile

Required. The conversation profile used to configure the search.

Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<Conversation Profile ID> .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getSessionId

The ID of the search session.

The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate Session ID . It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.

Returns
Type
Description
string

setSessionId

The ID of the search session.

The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate Session ID . It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getConversation

The conversation (between human agent and end user) where the search request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID> .

Returns
Type
Description
string

setConversation

The conversation (between human agent and end user) where the search request is triggered. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID> .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLatestMessage

The name of the latest conversation message when the request is triggered.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID> .

Returns
Type
Description
string

setLatestMessage

The name of the latest conversation message when the request is triggered.

Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/messages/<Message ID> .

Parameter
Name
Description
var
string
Returns
Type
Description
$this