Packages

ex_openai

2.0.0-beta2
2.0.0-beta3 2.0.0-beta2 2.0.0-beta 1.8.1-beta 1.8.0 1.8.0-beta 1.7.0 1.6.0 1.5.1 1.5.0 1.4.0 1.3.1 1.3.0 1.2.1 1.2.0 1.1.2 1.1.1 1.1.0 1.0.4 1.0.3 1.0.2 1.0.1 1.0.0 0.3.0 0.2.1 0.2.0 0.1.1 0.1.0

Auto-generated Elixir SDK for OpenAI APIs with proper typespec and @docs support

HexDocs

Current section

Files

Jump to
Readme
28 Versions
4 Dependencies
1 Dependant
Files
Activity
ex_openai lib ex_openai generated components assistant_tools_file_search.ex
Raw

lib/ex_openai/generated/components/assistant_tools_file_search.ex 

defmodule ExOpenAI.Components.AssistantToolsFileSearch do

  use ExOpenAI.Jason



  @moduledoc """

  Module for representing the OpenAI schema AssistantToolsFileSearch.



  ## Fields



  * `:file_search` - **optional** - `{:%{}, [], [{{:optional, [], [:max_num_results]}, {:integer, [], []}}, {{:optional, [], [:ranking_options]}, {{:., [], [ExOpenAI.Components.FileSearchRankingOptions, :t]}, [], []}}]}`  

    Overrides for the file search tool.



  * `:type` - **required** - `:file_search`  

    The type of tool being defined: `file_search`  

    Allowed values: `"file_search"`

  """

  @type t() :: %{

          __struct__: __MODULE__,

          file_search:

            %{

              optional(:max_num_results) => integer(),

              optional(:ranking_options) => ExOpenAI.Components.FileSearchRankingOptions.t()

            }

            | nil,

          type: :file_search

        }

  defstruct [:file_search, :type]

end