Google Cloud Dialogflow V2 Client - Class SearchKnowledgeRequest (1.17.2)

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

Required. The parent resource contains the conversation profile Format: 'projects/
↳ query 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

Required. 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

Optional. 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

Optional. 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>.
↳ query_source int

Optional. The source of the query in the request.
↳ end_user_metadata Google\Protobuf\Struct

Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] }
↳ search_config SearchKnowledgeRequest\SearchConfig

Optional. Configuration specific to search queries with data stores.
↳ exact_search bool

Optional. Whether to search the query exactly without query rewrite.

getParent

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

Returns
Type Description
string

setParent

Required. 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
TextInput|null

hasQuery

clearQuery

setQuery

Required. The natural language text query for knowledge search.

Parameter
Name Description
var 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

Required. 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

Required. 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

Optional. 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

Optional. 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

Optional. 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

Optional. 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

getQuerySource

Optional. The source of the query in the request.

Returns
Type Description
int

setQuerySource

Optional. The source of the query in the request.

Parameter
Name Description
var int
Returns
Type Description
$this

getEndUserMetadata

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example:

{
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    {"model": "Google Pixel 7"},
    {"model": "Google Pixel Tablet"}
  ]
}
Returns
Type Description
Google\Protobuf\Struct|null

hasEndUserMetadata

clearEndUserMetadata

setEndUserMetadata

Optional. Information about the end-user to improve the relevance and accuracy of generative answers.

This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example:

{
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    {"model": "Google Pixel 7"},
    {"model": "Google Pixel Tablet"}
  ]
}
Parameter
Name Description
var Google\Protobuf\Struct
Returns
Type Description
$this

getSearchConfig

Optional. Configuration specific to search queries with data stores.

Returns
Type Description
SearchKnowledgeRequest\SearchConfig|null

hasSearchConfig

clearSearchConfig

setSearchConfig

Optional. Configuration specific to search queries with data stores.

Parameter
Name Description
var SearchKnowledgeRequest\SearchConfig
Returns
Type Description
$this

getExactSearch

Optional. Whether to search the query exactly without query rewrite.

Returns
Type Description
bool

setExactSearch

Optional. Whether to search the query exactly without query rewrite.

Parameter
Name Description
var bool
Returns
Type Description
$this