View Source GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeRequest (google_api_dialogflow v0.79.0)

The request message for Conversations.SearchKnowledge.

Attributes

  • conversation (type: String.t, default: nil) - Optional. The conversation (between human agent and end user) where the search request is triggered. Format: projects//locations//conversations/.
  • conversationProfile (type: String.t, default: nil) - Required. The conversation profile used to configure the search. Format: projects//locations//conversationProfiles/.
  • latestMessage (type: String.t, default: nil) - Optional. The name of the latest conversation message when the request is triggered. Format: projects//locations//conversations//messages/.
  • parent (type: String.t, default: nil) - Required. The parent resource contains the conversation profile Format: 'projects/' or projects//locations/.
  • query (type: GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2TextInput.t, default: nil) - Required. The natural language text query for knowledge search.
  • sessionId (type: String.t, default: nil) - Optional. 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.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2SearchKnowledgeRequest{
    conversation: String.t() | nil,
    conversationProfile: String.t() | nil,
    latestMessage: String.t() | nil,
    parent: String.t() | nil,
    query:
      GoogleApi.Dialogflow.V2.Model.GoogleCloudDialogflowV2TextInput.t() | nil,
    sessionId: String.t() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.