Function calling and JSON mode
Function calling in SambaNova Cloud enables dynamic workflows by allowing the model to select and suggest function calls based on user input, which helps in building agentic workflows. By defining a set of functions, or tools, you provide context that lets the model recommend and fill in function arguments as needed.
How function calling works
Function calling enables adaptive workflows that leverage real-time data and structured outputs, creating more dynamic and responsive model interactions.
-
Submit a Query with tools: Start by submitting a user query along with available tools defined in JSON Schema. This schema specifies parameters for each function.
-
The model processes and suggests: The model interprets the query, assesses intent, and decides if it will respond conversationally or suggest function calls. If a function is called, it fills in the arguments based on the schema.
-
Receive a model response: You’ll get a response from the model, which may include a function call suggestion. Execute the function with the provided arguments and return the result to the model for further interaction.
Supported models
-
Meta-Llama-3.1-8B-Instruct
-
Meta-Llama-3.1-70B-Instruct
-
Meta-Llama-3.1-405B-Instruct
-
Meta-Llama-3.3-70B-Instruct
Meta recommends using Llama 70B-Instruct or Llama 405B-Instruct for applications that combine conversation and tool calling. Llama 8B-Instruct cannot reliably maintain a conversation alongside tool-calling definitions. It can be used for zero-shot tool calling, but tool instructions should be removed for regular conversations.
Example usage
The examples below describe each step of using function calling with an end-to-end example after the last step.
Step 1: Define the function schema
Define a JSON schema for your function. You will need to specify:
-
The name of the function.
-
A description of what it does.
-
The parameters, their data types, and descriptions.
Step 2: Configure function calling in your request
When sending a request to SN Cloud, include the function definition in the tools
parameter and set tool_choice
to the following:
-
auto
: allows the model to choose between generating a message or calling a function. This is the default tool choice when the field is not specified. -
required
: This forces the model to generate a function call. The model will then always select one or more function(s) to call. -
To enforce a specific function call, set
tool_choice = {"type": "function", "function": {"name": "solve_quadratic"}}
. This ensures the model will only use the specified function.
Step 3: Handle tool calls
If the model chooses to call a function, you will find tool_calls
in the response. Extract the function call details and execute the corresponding function with the provided parameters.
Step 4: Provide function results back to the model
Once you have computed the result, pass it back to the model to continue the conversation or confirm the output.
Step 5: Example output
An example output is shown below.
End-to-end example using OpenAI compatibility
JSON mode
You can set the response_format
parameter to json_object
in your request to ensure that the model outputs a valid JSON. In case the mode is not able to generate a valid JSON, an error will be returned.
In case the model fails to generate a valid JSON, you will get an error message Model did not output valid JSON.