View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaConverseConversationRequest (google_api_discovery_engine v0.7.0)

Request message for ConversationalSearchService.ConverseConversation method.

Attributes

  • boostSpec (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec.t, default: nil) - Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting
  • conversation (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaConversation.t, default: nil) - The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
  • filter (type: String.t, default: nil) - The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an INVALID_ARGUMENT is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter
  • query (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaTextInput.t, default: nil) - Required. Current user input.
  • safeSearch (type: boolean(), default: nil) - Whether to turn on safe search.
  • servingConfig (type: String.t, default: nil) - The resource name of the Serving Config to use. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id} If this is not set, the default serving config will be used.
  • summarySpec (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec.t, default: nil) - A specification for configuring the summary returned in the response.
  • userLabels (type: map(), default: nil) - The user labels applied to a resource must meet the following requirements: Each resource can have multiple labels, up to a maximum of 64. Each label must be a key-value pair. Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. The key portion of a label must be unique. However, you can use the same key with multiple resources. Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaConverseConversationRequest{
    boostSpec:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec.t()
      | nil,
    conversation:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaConversation.t()
      | nil,
    filter: String.t() | nil,
    query:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaTextInput.t()
      | nil,
    safeSearch: boolean() | nil,
    servingConfig: String.t() | nil,
    summarySpec:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec.t()
      | nil,
    userLabels: map() | nil
  }

Functions

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

Unwrap a decoded JSON object into its complex fields.