OpenAI

In this section we will cover how to set up and use OpenAI provider and OpenAI-Compatible provider with Flock. Before starting, you should have already followed the Getting Started guide.

OpenAI Provider Setup

To use OpenAI provider, you need first to get your OpenAI API key from the OpenAI website. Only two steps are required:

First Creating a secret with your OpenAI API key.

CREATE SECRET (
    TYPE OPENAI,
    API_KEY 'your-api-key'
);  

Create your OpenAI model in the model manager. Make sure that the name of the model is unique.

CREATE MODEL(
   'QuackingModel',
   'gpt-4o', 
   'openai', 
   {"tuple_format": "json", "max_batch_size": 32, "model_parameters": {"temperature": 0.7}}
);

Now you simply use Flock with OpenAI provider. Here’s a small query to run to test if everything is working:

SELECT llm_complete(
        {'model_name': 'QuackingModel'},
        {'prompt': 'Talk like a duck 🦆 and write a poem about a database 📚'}
        );

OpenAI-Compatible Provider Setup

For providers with OpenAI-compatible APIs, specify the BASE_URL along with your API key, to illustrate we will use groq as an example. You need only two required steps:

First Creating a secret for you groq provider by specifying its BASE_URL and API_KEY.

CREATE SECRET (
    TYPE OPENAI,
    BASE_URL 'https://api.groq.com/openai/v1/',
    API_KEY 'your-api-key'
);

Next, create your OpenAI-compatible model in the model manager. Make sure that the name of the model is unique.

CREATE MODEL(
   'QuackingModel',
   'gpt-4o', 
   'openai', 
   {"tuple_format": "json", "max_batch_size": 32, "model_parameters": {"temperature": 0.7}}
);

Same as before, you can test if everything is working with the same query:

SELECT llm_complete(
    {'model_name': 'QuackingModel'},
    {'prompt': 'Talk like a duck 🦆 and explain what a database is 📚'}
);

Home

Getting Started

Resource Management

Scalar Functions

Aggregate Functions

Hybrid Search

Operations

Contributing

OpenAI Provider Setup

OpenAI-Compatible Provider Setup

​OpenAI Provider Setup

​OpenAI-Compatible Provider Setup

OpenAI Provider Setup

OpenAI-Compatible Provider Setup