phoenix/litellm
1
0
Fork 0
forked from phoenix/litellm-mirror
Code Pull requests Activity

(docs) function calling

Browse source
This commit is contained in:
ishaan-jaff 2023-10-16 21:58:18 -07:00
parent 205f4a59e9
commit 8fa9dab9fe
1 changed files with 14 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/my-website/docs/completion/function_call.md
View file

@ -1,6 +1,7 @@
# Function Calling # Function Calling
LiteLLM only supports: OpenAI gpt-4-0613 and gpt-3.5-turbo-0613 for function calling LiteLLM only supports: OpenAI gpt-4-0613 and gpt-3.5-turbo-0613 for function calling
## Quick Start ## Quick Start
This is exactly how OpenAI supports function calling for gpt-4-0613 and gpt-3.5-turbo-0613
```python ```python
import os, litellm import os, litellm
from litellm import completion from litellm import completion
@ -11,10 +12,12 @@ messages = [
{"role": "user", "content": "What is the weather like in Boston?"} {"role": "user", "content": "What is the weather like in Boston?"}
] ]
# python function that will get executed
def get_current_weather(location): def get_current_weather(location):
if location == "Boston, MA": if location == "Boston, MA":
return "The weather is 12F" return "The weather is 12F"
# JSON Schema to pass to OpenAI
functions = [ functions = [
{ {
"name": "get_current_weather", "name": "get_current_weather",
@ -40,13 +43,16 @@ response = completion(model="gpt-3.5-turbo-0613", messages=messages, functions=f
print(response) print(response)
``` ```
## Using - litellm.utils.function_to_dict ## litellm.function_to_dict - Convert Functions to dictionary for OpenAI function calling
`function_to_dict` allows you to pass a function docstring and produce a dictionary usable for OpenAI function calling `function_to_dict` allows you to pass a function docstring and produce a dictionary usable for OpenAI function calling
### Usage ### Using `function_to_dict`
Define your function, use `litellm.utils.function_to_dict` to convert your function to a dictionary usable for OpenAI 1. Define your function `get_current_weather`
2. Add a docstring to your function `get_current_weather`
3. Pass the function to `litellm.utils.function_to_dict` to get the dictionary for OpenAI function calling
```python ```python
# function with docstring
def get_current_weather(location: str, unit: str): def get_current_weather(location: str, unit: str):
"""Get the current weather in a given location """Get the current weather in a given location
@ -64,11 +70,13 @@ def get_current_weather(location: str, unit: str):
""" """
if location == "Boston, MA": if location == "Boston, MA":
return "The weather is 12F" return "The weather is 12F"
# use litellm.utils.function_to_dict to convert function to dict
function_json = litellm.utils.function_to_dict(get_current_weather) function_json = litellm.utils.function_to_dict(get_current_weather)
print(function_json) print(function_json)
``` ```
#### Output #### Output from function_to_dict
```json ```json
{ {
'name': 'get_current_weather', 'name': 'get_current_weather',