Class: Google::Apis::FirebasemlV2beta::Retrieval

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firebaseml_v2beta/classes.rb,
lib/google/apis/firebaseml_v2beta/representations.rb,
lib/google/apis/firebaseml_v2beta/representations.rb

Overview

Defines a retrieval tool that model can call to access external knowledge.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Retrieval

Returns a new instance of Retrieval.



862
863
864
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 862

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#disable_attribution ⇒ Boolean Also known as: disable_attribution?

Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. Corresponds to the JSON property disableAttribution

Returns:

  • (Boolean) 


848
849
850
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 848

def disable_attribution
  @disable_attribution
end

#vertex_ai_search ⇒ Google::Apis::FirebasemlV2beta::VertexAiSearch

Retrieve from Vertex AI Search datastore for grounding. See https://cloud. google.com/vertex-ai-search-and-conversation Corresponds to the JSON property vertexAiSearch

Returns:



855
856
857
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 855

def vertex_ai_search
  @vertex_ai_search
end

#vertex_rag_store ⇒ Google::Apis::FirebasemlV2beta::VertexRagStore

Retrieve from Vertex RAG Store for grounding. Corresponds to the JSON property vertexRagStore

Returns:



860
861
862
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 860

def vertex_rag_store
  @vertex_rag_store
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



867
868
869
870
871
 
# File 'lib/google/apis/firebaseml_v2beta/classes.rb', line 867

def update!(**args)
  @disable_attribution = args[:disable_attribution] if args.key?(:disable_attribution)
  @vertex_ai_search = args[:vertex_ai_search] if args.key?(:vertex_ai_search)
  @vertex_rag_store = args[:vertex_rag_store] if args.key?(:vertex_rag_store)
end