ToolDataStoreTool class

Constructors

ToolDataStoreTool({Input<List<ToolDataStoreToolBoostSpec>?>? boostSpecs, Input<ToolDataStoreToolDataStoreSource?>? dataStoreSource, Input<String?>? description, Input<ToolDataStoreToolEngineSource?>? engineSource, Input<String?>? filterParameterBehavior, Input<int?>? maxResults, Input<List<ToolDataStoreToolModalityConfig>?>? modalityConfigs, required Input<String> name})

Creates a new ToolDataStoreTool. boostSpecs Boost specification to boost certain documents. dataStoreSource Optional. Search within a single specific DataStore. description The tool description. engineSource Configuration for searching within an Engine, potentially targeting filterParameterBehavior Optional. The filter parameter behavior. maxResults (Optional, Deprecated) modalityConfigs The modality configs for the data store. name The data store tool name.

const

ToolDataStoreTool.fromMap(Map<String, dynamic> map)

factory

Properties

boostSpecs → Input<List<ToolDataStoreToolBoostSpec>?>?

Boost specification to boost certain documents. Structure is documented below.

final

dataStoreSource → Input<ToolDataStoreToolDataStoreSource?>?

Optional. Search within a single specific DataStore. Structure is documented below.

final

description → Input<String?>?

The tool description.

final

engineSource → Input<ToolDataStoreToolEngineSource?>?

Configuration for searching within an Engine, potentially targeting specific DataStores. Structure is documented below.

final

filterParameterBehavior → Input<String?>?

Optional. The filter parameter behavior. Possible values: FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED ALWAYS_INCLUDE NEVER_INCLUDE Possible values are: FILTER_PARAMETER_BEHAVIOR_UNSPECIFIED, ALWAYS_INCLUDE, NEVER_INCLUDE.

final

hashCode → int

The hash code for this object.

no setter, inherited

maxResults → Input<int?>?

(Optional, Deprecated) Number of search results to return per query. The default value is 10. The maximum allowed value is 10.

final

modalityConfigs → Input<List<ToolDataStoreToolModalityConfig>?>?

The modality configs for the data store. Structure is documented below.

final

name → Input<String>

The data store tool name.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited