struct AI::OpenAI::Tools::FileSearch

• AI::OpenAI::Tools::FileSearch
• Struct
• Value
• Object

Overview

File Search tool.

Enables models to retrieve information from a knowledge base of previously uploaded files through semantic and keyword search.

Defined in:

ai/openai/tool/openai_tools.cr

Constant Summary

ID = "openai.file_search"

NAME = "file_search"

Constructors

• .new(vector_store_ids : Array(String), max_num_results : Int32 | Nil = nil, ranking : FileSearchRanking | Nil = nil, filters : FileSearchFilter | Nil = nil)

Instance Method Summary

• #args : Hash(String, JSON::Any)
• #filters : FileSearchFilter | Nil

  Filters to apply to the search.

• #id : String
• #max_num_results : Int32 | Nil

  Maximum number of search results to return.

• #name : String
• #ranking : FileSearchRanking | Nil

  Ranking options for the search.

• #type : String
• #vector_store_ids : Array(String)

  List of vector store IDs to search through.

Constructor Detail

Instance Method Detail