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

Service Deployment

Embedded Object Grooper.GPT

Represents a deployment of an OpenAI-compatible API endpoint.

Remarks

The ServiceDeployment class defines the configuration for a single OpenAI-compatible API endpoint, such as an OpenAI, Azure OpenAI, or private-hosted LLM service.

Overview

Each Service Deployment represents a single model endpoint, including its model ID, URL, authentication method, and any custom headers required for API access.

Configuration

  • Model Id: The identifier for the model exposed by this endpoint. This value is used to select the deployment for LLM operations.
  • URL: The full endpoint URL for the API. This should match the endpoint provided by your service provider.
  • Authorization: Select the authentication scheme required by your endpoint.
  • API Key: The secret key or token required for authentication. This is required for most endpoints except those using 'None'.
  • Headers: Optional. Specify additional HTTP headers as key=value pairs, one per line. These will be included in every API request.

Usage Notes

  • Each Service Deployment is typically managed as part of a collection within an LLM Provider such as Azure Provider.
  • Ensure that all required fields are set and that the API key is kept secure.
  • Use the 'Headers' property to add any custom headers required by your service, such as organization IDs or region information.

Properties

NameTypeDescription

Derived Types

There are 3 implementations of Service Deployment.

Chat Service Represents an endpoint compatible with the OpenAI 'chat/completions' API.
Embeddings Service Represents an endpoint compatible with the OpenAI 'embeddings' API.
Fine Tuning Service Represents an endpoint compatible with the OpenAI 'embeddings' API.

Used By

Azure Provider

Notification