│ Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Open AI Provider

LLM Provider Grooper.GPT

Defines a connection to the OpenAI API or an OpenAI-compatible service for use as an LLM provider in Grooper.

Remarks

The Open AI Provider class enables Grooper to connect to OpenAI or compatible large language model (LLM) APIs for AI-powered operations.

Overview

This provider allows you to configure Grooper to use OpenAI or similar services for tasks such as chat completions, embeddings, and fine-tuning. It supports both the official OpenAI API and third-party services that implement a compatible interface.

Configuration

  • URL: Set the 'URL' property to the base endpoint of your OpenAI or compatible API instance. The default value points to the official OpenAI endpoint (https://api.openai.com/v1).
  • Authorization: Choose the 'Authorization' method appropriate for your service. Most OpenAI-compatible APIs use either 'Bearer' or 'API Key' authentication. The 'API Key' property must be set if required by your chosen method.
  • API Key: Enter the API key or token provided by your service. This is required for most authorization methods except 'None'.
  • Use System Messages: When enabled, Grooper will send contextual information as system messages in chat-based LLM operations. This helps the LLM distinguish instructions from user input, which is recommended for most OpenAI models but may not be supported by all compatible services.

Compatibility

  • The provider is designed to work with the official OpenAI API as well as third-party services that implement a compatible API surface.
  • Some features, such as system messages or fine-tuning, may not be available on all compatible services.

Error Handling

  • Validation ensures that required properties are set based on the selected authorization method.
  • If the API key is missing or invalid, or if the service is unreachable, model listing and other operations will fail gracefully.

Properties

NameTypeDescription
General
Options
Notification