docs: Initial import from localai-website (#1312)

Signed-off-by: Ettore Di Giacinto <mudler@localai.io>
2025-05-20 10:35:01 +00:00 · 2023-11-22 18:13:50 +01:00 · 2023-11-22 18:13:50 +01:00 · c5c77d2b0d
commit c5c77d2b0d
parent 763f94ca80
66 changed files with 6111 additions and 0 deletions
--- a/docs/content/features/openai-functions.md
+++ b/docs/content/features/openai-functions.md
@ -0,0 +1,126 @@
+
+++
+disableToc = false
+title = "🔥 OpenAI functions"
+weight = 2
+++
+
+LocalAI supports running OpenAI functions with `llama.cpp` compatible models.
+
+![localai-functions-1](https://github.com/ggerganov/llama.cpp/assets/2420543/5bd15da2-78c1-4625-be90-1e938e6823f1)
+
+To learn more about OpenAI functions, see the [OpenAI API blog post](https://openai.com/blog/function-calling-and-other-api-updates).
+
+💡 Check out also [LocalAGI](https://github.com/mudler/LocalAGI) for an example on how to use LocalAI functions.
+
+## Setup
+
+OpenAI functions are available only with `ggml` or `gguf` models compatible with `llama.cpp`.
+
+You don't need to do anything specific - just use `ggml` or `gguf` models.
+
+
+## Usage example
+
+You can configure a model manually with a YAML config file in the models directory, for example:
+
+```yaml
+name: gpt-3.5-turbo
+parameters:
+  # Model file name
+  model: ggml-openllama.bin
+  top_p: 80
+  top_k: 0.9
+  temperature: 0.1
+```
+
+To use the functions with the OpenAI client in python:
+
+```python
+import openai
+# ...
+# Send the conversation and available functions to GPT
+messages = [{"role": "user", "content": "What's the weather like in Boston?"}]
+functions = [
+    {
+        "name": "get_current_weather",
+        "description": "Get the current weather in a given location",
+        "parameters": {
+            "type": "object",
+            "properties": {
+                "location": {
+                    "type": "string",
+                    "description": "The city and state, e.g. San Francisco, CA",
+                },
+                "unit": {"type": "string", "enum": ["celsius", "fahrenheit"]},
+            },
+            "required": ["location"],
+        },
+    }
+]
+response = openai.ChatCompletion.create(
+    model="gpt-3.5-turbo",
+    messages=messages,
+    functions=functions,
+    function_call="auto",
+)
+# ...
+```
+
+{{% notice note %}}
+When running the python script, be sure to:
+
+- Set `OPENAI_API_KEY` environment variable to a random string (the OpenAI api key is NOT required!)
+- Set `OPENAI_API_BASE` to point to your LocalAI service, for example `OPENAI_API_BASE=http://localhost:8080`
+
+{{% /notice %}}
+
+## Advanced
+
+It is possible to also specify the full function signature (for debugging, or to use with other clients).
+
+The chat endpoint accepts the `grammar_json_functions` additional parameter which takes a JSON schema object.
+
+For example, with curl:
+
+```bash
+curl http://localhost:8080/v1/chat/completions -H "Content-Type: application/json" -d '{
+     "model": "gpt-4",
+     "messages": [{"role": "user", "content": "How are you?"}],
+     "temperature": 0.1,
+     "grammar_json_functions": {
+        "oneOf": [
+            {
+                "type": "object",
+                "properties": {
+                    "function": {"const": "create_event"},
+                    "arguments": {
+                        "type": "object",
+                        "properties": {
+                            "title": {"type": "string"},
+                            "date": {"type": "string"},
+                            "time": {"type": "string"}
+                        }
+                    }
+                }
+            },
+            {
+                "type": "object",
+                "properties": {
+                    "function": {"const": "search"},
+                    "arguments": {
+                        "type": "object",
+                        "properties": {
+                            "query": {"type": "string"}
+                        }
+                    }
+                }
+            }
+        ]
+    }
+   }'
+```
+
+## 💡 Examples
+
+A full e2e example with `docker-compose` is available [here](https://github.com/go-skynet/LocalAI/tree/master/examples/functions).