View Source ExOpenAI.Components.CreateAssistantRequest (ex_openai.ex v2.0.0-beta2)

Module for representing the OpenAI schema CreateAssistantRequest.

Fields

:description - optional - String.t() | any()
:instructions - optional - String.t() | any()
:metadata - optional - ExOpenAI.Components.Metadata.t()
:model - required - String.t() | ExOpenAI.Components.AssistantSupportedModels.t()
ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.
:name - optional - String.t() | any()
:reasoning_effort - optional - ExOpenAI.Components.ReasoningEffort.t()
:response_format - optional - ExOpenAI.Components.AssistantsApiResponseFormatOption.t() | any()
:temperature - optional - number() | any()
:tool_resources - optional - {:%{}, [], [{{:optional, [], [:code_interpreter]}, {:%{}, [], [{{:optional, [], [:file_ids]}, {:list, [], [{{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}]}}]}}, {{:optional, [], [:file_search]}, {:%{}, [], [{{:optional, [], [:vector_store_ids]}, {:list, [], [{{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}]}}, {{:optional, [], [:vector_stores]}, {:list, [], [{:%{}, [], [{{:optional, [], [:chunking_strategy]}, {:map, [], []}}, {{:optional, [], [:file_ids]}, {:list, [], [{{:., [], [{:__aliases__, [alias: false], [:String]}, :t]}, [], []}]}}, {{:optional, [], [:metadata]}, {{:., [], [ExOpenAI.Components.Metadata, :t]}, [], []}}]}]}}]}}]} | any()
:tools - optional - [ExOpenAI.Components.AssistantToolsCode.t() | ExOpenAI.Components.AssistantToolsFileSearch.t() | ExOpenAI.Components.AssistantToolsFunction.t()]
A list of tool enabled on the assistant. There can be a maximum of 128 tools per assistant. Tools can be of types code_interpreter, file_search, or function.
Default: []
Constraints: maxItems: 128
:top_p - optional - number() | any()

Summary

Types

t()

Types

t()

@type t() :: %ExOpenAI.Components.CreateAssistantRequest{
  description: (String.t() | any()) | nil,
  instructions: (String.t() | any()) | nil,
  metadata: ExOpenAI.Components.Metadata.t() | nil,
  model: String.t() | ExOpenAI.Components.AssistantSupportedModels.t(),
  name: (String.t() | any()) | nil,
  reasoning_effort: ExOpenAI.Components.ReasoningEffort.t() | nil,
  response_format:
    (ExOpenAI.Components.AssistantsApiResponseFormatOption.t() | any()) | nil,
  temperature: (number() | any()) | nil,
  tool_resources:
    (%{
       optional(:code_interpreter) => %{optional(:file_ids) => [String.t()]},
       optional(:file_search) => %{
         optional(:vector_store_ids) => [String.t()],
         optional(:vector_stores) => [
           %{
             optional(:chunking_strategy) => map(),
             optional(:file_ids) => [String.t()],
             optional(:metadata) => ExOpenAI.Components.Metadata.t()
           }
         ]
       }
     }
     | any())
    | nil,
  tools:
    [
      (ExOpenAI.Components.AssistantToolsCode.t()
       | ExOpenAI.Components.AssistantToolsFileSearch.t())
      | ExOpenAI.Components.AssistantToolsFunction.t()
    ]
    | nil,
  top_p: (number() | any()) | nil
}