Class: OpenAI::Models::VectorStoreSearchParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• OpenAI::Models::VectorStoreSearchParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/openai/models/vector_store_search_params.rb

Overview

See Also:

• Resources::VectorStores#search

Defined Under Namespace

Modules: Filters, Query Classes: RankingOptions

Instance Attribute Summary

• #filters ⇒ OpenAI::Models::ComparisonFilter, ...

  A filter to apply based on file attributes.

• #max_num_results ⇒ Integer^?

  The maximum number of results to return.

• #query ⇒ String⁺

  A query string for a search.

• #ranking_options ⇒ OpenAI::Models::VectorStoreSearchParams::RankingOptions^?

  Ranking options for search.

• #rewrite_query ⇒ Boolean^?

  Whether to rewrite the natural language query for vector search.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .variants ⇒ Array(OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter)

Instance Method Summary

• #initialize(query: , filters: nil, max_num_results: nil, ranking_options: nil, rewrite_query: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see VectorStoreSearchParams for more details.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(query: , filters: nil, max_num_results: nil, ranking_options: nil, rewrite_query: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see OpenAI::Models::VectorStoreSearchParams for more details.

Parameters:

• query (String, Array<String>) (defaults to: ) —

  A query string for a search

• filters (OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter) (defaults to: nil) —

  A filter to apply based on file attributes.

• max_num_results (Integer) (defaults to: nil) —

  The maximum number of results to return. This number should be between 1 and 50

• ranking_options (OpenAI::Models::VectorStoreSearchParams::RankingOptions) (defaults to: nil) —

  Ranking options for search.

• rewrite_query (Boolean) (defaults to: nil) —

  Whether to rewrite the natural language query for vector search.

• request_options (OpenAI::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/openai/models/vector_store_search_params.rb', line 41

Instance Attribute Details

#filters ⇒ OpenAI::Models::ComparisonFilter, ...

A filter to apply based on file attributes.

Returns:

• (OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter, nil)

# File 'lib/openai/models/vector_store_search_params.rb', line 20

optional :filters, union: -> { OpenAI::VectorStoreSearchParams::Filters }

#max_num_results ⇒ Integer^?

The maximum number of results to return. This number should be between 1 and 50 inclusive.

Returns:

• (Integer, nil)

# File 'lib/openai/models/vector_store_search_params.rb', line 27

optional :max_num_results, Integer

#query ⇒ String⁺

A query string for a search

Returns:

• (String, Array<String>)

# File 'lib/openai/models/vector_store_search_params.rb', line 14

required :query, union: -> { OpenAI::VectorStoreSearchParams::Query }

#ranking_options ⇒ OpenAI::Models::VectorStoreSearchParams::RankingOptions^?

Ranking options for search.

Returns:

• (OpenAI::Models::VectorStoreSearchParams::RankingOptions, nil)

# File 'lib/openai/models/vector_store_search_params.rb', line 33

optional :ranking_options, -> { OpenAI::VectorStoreSearchParams::RankingOptions }

#rewrite_query ⇒ Boolean^?

Whether to rewrite the natural language query for vector search.

Returns:

• (Boolean, nil)

# File 'lib/openai/models/vector_store_search_params.rb', line 39

optional :rewrite_query, OpenAI::Internal::Type::Boolean

Class Method Details

.variants ⇒ Array(OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter)

Returns:

• (Array(OpenAI::Models::ComparisonFilter, OpenAI::Models::CompoundFilter))

# File 'lib/openai/models/vector_store_search_params.rb', line 82