class

OpenAI::VectorStoreSearchRequest

Inherits JSON::Serializable < Reference < Object

Constructors

new(pull : JSON::PullParser)
Source
new(query : VectorStoreSearchRequestQuery = "", rewrite_query : Bool | Nil = nil, max_num_results : Int64 | Nil = nil, filters : VectorStoreSearchRequestFilters | Nil = nil, ranking_options : VectorStoreSearchRequestRankingOptions | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

filters

A filter to apply based on file attributes.

Source
filters=(filters : VectorStoreSearchRequestFilters | Nil)

A filter to apply based on file attributes.

Source
max_num_results

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

Source
max_num_results=(max_num_results : Int64 | Nil)

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

Source
query

A query string for a search

Source
query=(query : VectorStoreSearchRequestQuery)

A query string for a search

Source
ranking_options

Ranking options for search.

Source
ranking_options=(ranking_options : VectorStoreSearchRequestRankingOptions | Nil)

Ranking options for search.

Source
rewrite_query

Whether to rewrite the natural language query for vector search.

Source
rewrite_query=(rewrite_query : Bool | Nil)

Whether to rewrite the natural language query for vector search.

Source