Class: Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb

Overview

Grounding source.

Defined Under Namespace

Classes: EnterpriseWebRetrievalSource, GoogleSearchSource, InlineSource, SearchSource

Instance Attribute Summary collapse

Instance Attribute Details

#enterprise_web_retrieval_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource::EnterpriseWebRetrievalSource

Returns If set, grounding is performed with enterprise web retrieval.

Note: The following fields are mutually exclusive: enterprise_web_retrieval_source, inline_source, search_source, google_search_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 183

class GroundingSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message to be used for grounding based on inline content.
  # @!attribute [rw] grounding_facts
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact>]
  #     List of facts to be used for grounding.
  # @!attribute [rw] attributes
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Attributes associated with the content.
  #
  #     Common attributes include `source` (indicating where the content was
  #     sourced from) and `author` (indicating the author of the content).
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AttributesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Message to be used for grounding with Vertex AI Search.
  # @!attribute [rw] serving_config
  #   @return [::String]
  #     The resource name of the Engine to use.
  #
  #     Format:
  #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
  # @!attribute [rw] max_result_count
  #   @return [::Integer]
  #     Number of search results to return.
  #
  #     The default value is 10. The maximumm allowed value is 10.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Filter expression to be applied to the search.
  #
  #     The syntax is the same as
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] safe_search
  #   @return [::Boolean]
  #     If set, safe search is enabled in Vertex AI Search requests.
  class SearchSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Google Search config parameters.
  # @!attribute [rw] dynamic_retrieval_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::DynamicRetrievalConfiguration]
  #     Optional. Specifies the dynamic retrieval configuration for the given
  #     source.
  class GoogleSearchSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Params for using enterprise web retrieval as grounding source.
  class EnterpriseWebRetrievalSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#google_search_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource::GoogleSearchSource

Returns If set, grounding is performed with Google Search.

Note: The following fields are mutually exclusive: google_search_source, inline_source, search_source, enterprise_web_retrieval_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 183

class GroundingSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message to be used for grounding based on inline content.
  # @!attribute [rw] grounding_facts
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact>]
  #     List of facts to be used for grounding.
  # @!attribute [rw] attributes
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Attributes associated with the content.
  #
  #     Common attributes include `source` (indicating where the content was
  #     sourced from) and `author` (indicating the author of the content).
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AttributesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Message to be used for grounding with Vertex AI Search.
  # @!attribute [rw] serving_config
  #   @return [::String]
  #     The resource name of the Engine to use.
  #
  #     Format:
  #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
  # @!attribute [rw] max_result_count
  #   @return [::Integer]
  #     Number of search results to return.
  #
  #     The default value is 10. The maximumm allowed value is 10.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Filter expression to be applied to the search.
  #
  #     The syntax is the same as
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] safe_search
  #   @return [::Boolean]
  #     If set, safe search is enabled in Vertex AI Search requests.
  class SearchSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Google Search config parameters.
  # @!attribute [rw] dynamic_retrieval_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::DynamicRetrievalConfiguration]
  #     Optional. Specifies the dynamic retrieval configuration for the given
  #     source.
  class GoogleSearchSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Params for using enterprise web retrieval as grounding source.
  class EnterpriseWebRetrievalSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#inline_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource::InlineSource

Returns If set, grounding is performed with inline content.

Note: The following fields are mutually exclusive: inline_source, search_source, google_search_source, enterprise_web_retrieval_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 183

class GroundingSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message to be used for grounding based on inline content.
  # @!attribute [rw] grounding_facts
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact>]
  #     List of facts to be used for grounding.
  # @!attribute [rw] attributes
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Attributes associated with the content.
  #
  #     Common attributes include `source` (indicating where the content was
  #     sourced from) and `author` (indicating the author of the content).
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AttributesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Message to be used for grounding with Vertex AI Search.
  # @!attribute [rw] serving_config
  #   @return [::String]
  #     The resource name of the Engine to use.
  #
  #     Format:
  #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
  # @!attribute [rw] max_result_count
  #   @return [::Integer]
  #     Number of search results to return.
  #
  #     The default value is 10. The maximumm allowed value is 10.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Filter expression to be applied to the search.
  #
  #     The syntax is the same as
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] safe_search
  #   @return [::Boolean]
  #     If set, safe search is enabled in Vertex AI Search requests.
  class SearchSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Google Search config parameters.
  # @!attribute [rw] dynamic_retrieval_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::DynamicRetrievalConfiguration]
  #     Optional. Specifies the dynamic retrieval configuration for the given
  #     source.
  class GoogleSearchSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Params for using enterprise web retrieval as grounding source.
  class EnterpriseWebRetrievalSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#search_source ⇒ ::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::GroundingSource::SearchSource

Returns If set, grounding is performed with Vertex AI Search.

Note: The following fields are mutually exclusive: search_source, inline_source, google_search_source, enterprise_web_retrieval_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'proto_docs/google/cloud/discoveryengine/v1/grounded_generation_service.rb', line 183

class GroundingSource
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Message to be used for grounding based on inline content.
  # @!attribute [rw] grounding_facts
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::GroundingFact>]
  #     List of facts to be used for grounding.
  # @!attribute [rw] attributes
  #   @return [::Google::Protobuf::Map{::String => ::String}]
  #     Attributes associated with the content.
  #
  #     Common attributes include `source` (indicating where the content was
  #     sourced from) and `author` (indicating the author of the content).
  class InlineSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # @!attribute [rw] key
    #   @return [::String]
    # @!attribute [rw] value
    #   @return [::String]
    class AttributesEntry
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Message to be used for grounding with Vertex AI Search.
  # @!attribute [rw] serving_config
  #   @return [::String]
  #     The resource name of the Engine to use.
  #
  #     Format:
  #     `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}`
  # @!attribute [rw] max_result_count
  #   @return [::Integer]
  #     Number of search results to return.
  #
  #     The default value is 10. The maximumm allowed value is 10.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Filter expression to be applied to the search.
  #
  #     The syntax is the same as
  #     {::Google::Cloud::DiscoveryEngine::V1::SearchRequest#filter SearchRequest.filter}.
  # @!attribute [rw] safe_search
  #   @return [::Boolean]
  #     If set, safe search is enabled in Vertex AI Search requests.
  class SearchSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Google Search config parameters.
  # @!attribute [rw] dynamic_retrieval_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1::GenerateGroundedContentRequest::DynamicRetrievalConfiguration]
  #     Optional. Specifies the dynamic retrieval configuration for the given
  #     source.
  class GoogleSearchSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Params for using enterprise web retrieval as grounding source.
  class EnterpriseWebRetrievalSource
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end