Documentation
¶
Overview ¶
Package openai provides OpenAI provider adapter for the OmniLLM unified interface
Package openai provides OpenAI API client implementation
Index ¶
- func NewProvider(apiKey, baseURL string, httpClient *http.Client) provider.Provider
- type Choice
- type Client
- type Message
- type Provider
- func (p *Provider) Close() error
- func (p *Provider) CreateChatCompletion(ctx context.Context, req *provider.ChatCompletionRequest) (*provider.ChatCompletionResponse, error)
- func (p *Provider) CreateChatCompletionStream(ctx context.Context, req *provider.ChatCompletionRequest) (provider.ChatCompletionStream, error)
- func (p *Provider) Name() string
- type Request
- type Response
- type Stream
- type StreamAdapter
- type StreamChoice
- type StreamChunk
- type Usage
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Choice ¶
type Choice struct {
Index int `json:"index"`
Message Message `json:"message"`
FinishReason *string `json:"finish_reason"`
}
Choice represents a choice in the response
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client implements OpenAI API client
func (*Client) CreateCompletion ¶
CreateCompletion creates a chat completion
func (*Client) CreateCompletionStream ¶
CreateCompletionStream creates a streaming chat completion
type Message ¶
type Message struct {
Role string `json:"role"`
Content string `json:"content"`
Name *string `json:"name,omitempty"`
}
Message represents a chat message
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider represents the OpenAI provider adapter
func (*Provider) CreateChatCompletion ¶
func (p *Provider) CreateChatCompletion(ctx context.Context, req *provider.ChatCompletionRequest) (*provider.ChatCompletionResponse, error)
CreateChatCompletion creates a chat completion
func (*Provider) CreateChatCompletionStream ¶
func (p *Provider) CreateChatCompletionStream(ctx context.Context, req *provider.ChatCompletionRequest) (provider.ChatCompletionStream, error)
CreateChatCompletionStream creates a streaming chat completion
type Request ¶
type Request struct {
Model string `json:"model"`
Messages []Message `json:"messages"`
MaxTokens *int `json:"max_tokens,omitempty"`
Temperature *float64 `json:"temperature,omitempty"`
TopP *float64 `json:"top_p,omitempty"`
Stream *bool `json:"stream,omitempty"`
Stop []string `json:"stop,omitempty"`
PresencePenalty *float64 `json:"presence_penalty,omitempty"`
FrequencyPenalty *float64 `json:"frequency_penalty,omitempty"`
LogitBias map[string]int `json:"logit_bias,omitempty"`
User *string `json:"user,omitempty"`
}
Request represents an OpenAI chat completion request
type Response ¶
type Response struct {
ID string `json:"id"`
Object string `json:"object"`
Created int64 `json:"created"`
Model string `json:"model"`
Choices []Choice `json:"choices"`
Usage Usage `json:"usage"`
}
Response represents an OpenAI chat completion response
type Stream ¶
type Stream struct {
// contains filtered or unexported fields
}
Stream implements streaming for OpenAI
func (*Stream) Recv ¶
func (s *Stream) Recv() (*StreamChunk, error)
Recv receives the next chunk from the stream
type StreamAdapter ¶
type StreamAdapter struct {
// contains filtered or unexported fields
}
StreamAdapter adapts OpenAI stream to unified interface
func (*StreamAdapter) Recv ¶
func (s *StreamAdapter) Recv() (*provider.ChatCompletionChunk, error)
Recv receives the next chunk from the stream
type StreamChoice ¶
type StreamChoice struct {
Index int `json:"index"`
Delta *Message `json:"delta,omitempty"`
FinishReason *string `json:"finish_reason"`
}
StreamChoice represents a choice in streaming response
type StreamChunk ¶
type StreamChunk struct {
ID string `json:"id"`
Object string `json:"object"`
Created int64 `json:"created"`
Model string `json:"model"`
Choices []StreamChoice `json:"choices"`
Usage *Usage `json:"usage,omitempty"`
}
StreamChunk represents a chunk in streaming response
Source Files