Class: Langchain::Assistant::LLM::Adapters::OpenAI
- Defined in:
- lib/langchain/assistant/llm/adapters/openai.rb
Instance Method Summary collapse
-
#allowed_tool_choices ⇒ Object
Get the allowed assistant.tool_choice values for OpenAI.
-
#available_tool_names(tools) ⇒ Object
Get the available tool names for OpenAI.
-
#build_chat_params(messages:, instructions:, tools:, tool_choice:, parallel_tool_calls:) ⇒ Hash
Build the chat parameters for the OpenAI LLM.
-
#build_message(role:, content: nil, image_url: nil, tool_calls: [], tool_call_id: nil) ⇒ Messages::OpenAIMessage
Build a OpenAI message.
-
#build_tools(tools) ⇒ Object
Build the tools for the OpenAI LLM.
-
#extract_tool_call_args(tool_call:) ⇒ Array
Extract the tool call information from the OpenAI tool call hash.
- #support_system_message? ⇒ Boolean
- #tool_role ⇒ Object
Instance Method Details
#allowed_tool_choices ⇒ Object
Get the allowed assistant.tool_choice values for OpenAI
70 71 72 |
# File 'lib/langchain/assistant/llm/adapters/openai.rb', line 70 def allowed_tool_choices ["auto", "none"] end |
#available_tool_names(tools) ⇒ Object
Get the available tool names for OpenAI
75 76 77 |
# File 'lib/langchain/assistant/llm/adapters/openai.rb', line 75 def available_tool_names(tools) build_tools(tools).map { |tool| tool.dig(:function, :name) } end |
#build_chat_params(messages:, instructions:, tools:, tool_choice:, parallel_tool_calls:) ⇒ Hash
Build the chat parameters for the OpenAI LLM
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
# File 'lib/langchain/assistant/llm/adapters/openai.rb', line 16 def build_chat_params( messages:, instructions:, tools:, tool_choice:, parallel_tool_calls: ) params = {messages: } if tools.any? params[:tools] = build_tools(tools) params[:tool_choice] = build_tool_choice(tool_choice) params[:parallel_tool_calls] = parallel_tool_calls end params end |
#build_message(role:, content: nil, image_url: nil, tool_calls: [], tool_call_id: nil) ⇒ Messages::OpenAIMessage
Build a OpenAI message
40 41 42 |
# File 'lib/langchain/assistant/llm/adapters/openai.rb', line 40 def (role:, content: nil, image_url: nil, tool_calls: [], tool_call_id: nil) Messages::OpenAIMessage.new(role: role, content: content, image_url: image_url, tool_calls: tool_calls, tool_call_id: tool_call_id) end |
#build_tools(tools) ⇒ Object
Build the tools for the OpenAI LLM
65 66 67 |
# File 'lib/langchain/assistant/llm/adapters/openai.rb', line 65 def build_tools(tools) tools.map { |tool| tool.class.function_schemas.to_openai_format }.flatten end |
#extract_tool_call_args(tool_call:) ⇒ Array
Extract the tool call information from the OpenAI tool call hash
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/langchain/assistant/llm/adapters/openai.rb', line 48 def extract_tool_call_args(tool_call:) tool_call_id = tool_call.dig("id") function_name = tool_call.dig("function", "name") tool_name, method_name = function_name.split("__") tool_arguments = tool_call.dig("function", "arguments") tool_arguments = if tool_arguments.is_a?(Hash) Langchain::Utils::HashTransformer.symbolize_keys(tool_arguments) else JSON.parse(tool_arguments, symbolize_names: true) end [tool_call_id, tool_name, method_name, tool_arguments] end |
#support_system_message? ⇒ Boolean
83 84 85 |
# File 'lib/langchain/assistant/llm/adapters/openai.rb', line 83 def Messages::OpenAIMessage::ROLES.include?("system") end |
#tool_role ⇒ Object
79 80 81 |
# File 'lib/langchain/assistant/llm/adapters/openai.rb', line 79 def tool_role Messages::OpenAIMessage::TOOL_ROLE end |