Class: Google::Apis::CesV1::FileSearchTool

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

Overview

The file search tool allows the agent to search across the files uploaded by the app/agent developer. It has presets to give relatively good quality search over the uploaded files and summarization of the retrieved results.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FileSearchTool

Returns a new instance of FileSearchTool.



3275
3276
3277
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3275

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

Instance Attribute Details

#corpus_type ⇒ String

Optional. The type of the corpus. Default is FULLY_MANAGED. Corresponds to the JSON property corpusType

Returns:

  • (String) 


3257
3258
3259
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3257

def corpus_type
  @corpus_type
end

#description ⇒ String

Optional. The tool description. Corresponds to the JSON property description

Returns:

  • (String) 


3262
3263
3264
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3262

def description
  @description
end

#file_corpus ⇒ String

Optional. The corpus where files are stored. Format: projects/project/ locations/location/ragCorpora/rag_corpus Corresponds to the JSON property fileCorpus

Returns:

  • (String) 


3268
3269
3270
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3268

def file_corpus
  @file_corpus
end

#name ⇒ String

Required. The tool name. Corresponds to the JSON property name

Returns:

  • (String) 


3273
3274
3275
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3273

def name
  @name
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3280
3281
3282
3283
3284
3285
 
# File 'lib/google/apis/ces_v1/classes.rb', line 3280

def update!(**args)
  @corpus_type = args[:corpus_type] if args.key?(:corpus_type)
  @description = args[:description] if args.key?(:description)
  @file_corpus = args[:file_corpus] if args.key?(:file_corpus)
  @name = args[:name] if args.key?(:name)
end