---
warning: DO NOT CHANGE THIS MANUALLY, THIS IS GENERATED BY https://github.com/duckdb/community-extensions repository, check README there
title: open_prompt
excerpt: |
  DuckDB Community Extensions
  Interact with LLMs with a simple DuckDB Extension

docs:
  extended_description: "## Open Prompt Extension\nThe `open_prompt()` community extension\
    \ is shamelessly inspired by the Motherduck `prompt()` but focused on self-hosted\
    \ usage.\n\n> For examples and instructions check out the `open_prompt()` [README](https://github.com/quackscience/duckdb-extension-openprompt)\n\
    \n### Configuration\nSetup the completions API URL configuration w/ optional auth\
    \ token and model name\n\n```\nSET VARIABLE openprompt_api_url = 'http://localhost:11434/v1/chat/completions';\n\
    SET VARIABLE openprompt_api_token = 'your_api_key_here';\nSET VARIABLE openprompt_model_name\
    \ = 'qwen2.5:0.5b';\n```\n\nAlternatively the following ENV variables can be used\
    \ at runtime\n\n```\nOPEN_PROMPT_API_URL='http://localhost:11434/v1/chat/completions'\n\
    OPEN_PROMPT_API_TOKEN='your_api_key_here'\nOPEN_PROMPT_MODEL_NAME='qwen2.5:0.5b'\n\
    OPEN_PROMPT_API_TIMEOUT='30'\n```\n\nFor persistent usage, configure parameters\
    \ using DuckDB `SECRETS`\n\n```sql\nCREATE PERSISTENT SECRET IF NOT EXISTS open_prompt\
    \ (\n      TYPE open_prompt,\n      PROVIDER config,\n      api_token 'your-api-token',\n\
    \      api_url 'http://localhost:11434/v1/chat/completions',\n      model_name\
    \ 'qwen2.5:0.5b',\n      api_timeout '30'\n  );\n```"
  hello_world: "-- Configure the required parameters to access OpenAI Completions\
    \ compatible APIs\nD CREATE SECRET IF NOT EXISTS open_prompt (\n      TYPE open_prompt,\n\
    \      PROVIDER config,\n      api_token 'your-api-token',\n      api_url 'http://localhost:11434/v1/chat/completions',\n\
    \      model_name 'qwen2.5:0.5b',\n      api_timeout '30'\n  );\n\n-- Prompt any\
    \ OpenAI Completions API form your query\nD SELECT open_prompt('Write a one-line\
    \ poem about ducks') AS response;\n\u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2510\n\u2502                    response                    \u2502\
    \n\u2502                    varchar                     \u2502\n\u251C\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n\u2502 Ducks quacking at dawn,\
    \ swimming in the light. \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\
    \u2500\u2500\u2518\n\n-- Prompt requesting JSON Structured Output for ChatGPT,\
    \ LLama3, etc\nSET VARIABLE openprompt_model_name = 'llama3.2:3b';\nSELECT open_prompt('I\
    \ want ice cream', json_schema := '{\n   \"type\": \"object\",\n   \"properties\"\
    : {\n     \"summary\": { \"type\": \"string\" },\n     \"sentiment\": { \"type\"\
    : \"string\", \"enum\": [\"pos\", \"neg\", \"neutral\"] }\n   },\n   \"required\"\
    : [\"summary\", \"sentiment\"],\n   \"additionalProperties\": false\n }');\n\n\
    -- Use Custom System Prompt to request JSON Output in smaller models\nSET VARIABLE\
    \ openprompt_model_name = 'qwen2.5:1.5b';\nSELECT open_prompt('I want ice cream.',\
    \ system_prompt:='Response MUST be JSON with the following schema: {\n       \"\
    type\": \"object\",\n       \"properties\": {\n         \"summary\": { \"type\"\
    : \"string\" },\n         \"sentiment\": { \"type\": \"string\", \"enum\": [\"\
    pos\", \"neg\", \"neutral\"] }\n       },\n       \"required\": [\"summary\",\
    \ \"sentiment\"],\n       \"additionalProperties\": false\n     }');\n"
extension:
  build: cmake
  description: Interact with LLMs with a simple DuckDB Extension
  excluded_platforms: windows_amd64_rtools
  language: C++
  license: MIT
  maintainers:
  - lmangani
  - akvlad
  name: open_prompt
  version: '2025120401'
repo:
  andium: 5328a2ff7100887263259ccc5ad8c03b8c6bc58a
  github: quackscience/duckdb-extension-openprompt
  ref: 725b1a99a20c1f627b81fa86c026f7d2b9146576

extension_star_count: 62
extension_star_count_pretty: 62
extension_download_count: 886
extension_download_count_pretty: 886
image: '/images/community_extensions/social_preview/preview_community_extension_open_prompt.png'
layout: community_extension_doc
---
### Compatibility Matrix

This table covers all DuckDB releases that have not reached [end-of-life](https://duckdb.org/release_calendar), including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

<div class="extension_compatibility_table"></div>

| Platform | 1.4.4 | 1.4.5 | 1.5.5 | 1.5.6 | 2.0.0 |
| :--- | :---: | :---: | :---: | :---: | :---: |
| Linux AMD64 | ✅ | ✅ | ✅ | ✅ | ✅ |
| Linux ARM64 | ✅ | ✅ | ✅ | ✅ | ✅ |
| macOS AMD64 | ✅ | ✅ | ✅ | ✅ | ✅ |
| macOS ARM64 | ✅ | ✅ | ✅ | ✅ | ✅ |
| Windows AMD64 | ✅ | ✅ | ✅ | ✅ | ✅ |
| Windows ARM64 | ❌ | ❌ | ❌ | ❌ | ❌ |
| WebAssembly | ✅ | ✅ | ✅ | ✅ | ✅ |

### Installing and Loading
```sql
INSTALL {{ page.extension.name }} FROM community;
LOAD {{ page.extension.name }};
```

{% if page.docs.hello_world %}
### Example
```sql
{{ page.docs.hello_world }}```
{% endif %}

{% if page.docs.extended_description %}
### About {{ page.extension.name }}
{{ page.docs.extended_description }}
{% endif %}
### Added Functions

<div class="extension_functions_table"></div>

This extension does not add any functions.

### Overloaded Functions

<div class="extension_functions_table"></div>

This extension does not add any function overloads.

### Added Types

<div class="extension_types_table"></div>

This extension does not add any types.

### Added Settings

<div class="extension_settings_table"></div>

This extension does not add any settings.