provider

Documentation

Overview

Package provider defines the ai.Provider interface and provides a mock provider for unittest.

Index

• Variables
• func ListProviders() []string
• func RegisterProvider(provider LLMProvider)
• type LLMProvider
  • func GetProvider(name string) (LLMProvider, error)
• type Mock
  • func NewMock(name string, data ...MockData) (*Mock, error)
  • func (m *Mock) GetChatCompletions(_ context.Context, req openai.ChatCompletionRequest, _ metadata.M) (openai.ChatCompletionResponse, error)
  • func (m *Mock) GetChatCompletionsStream(_ context.Context, req openai.ChatCompletionRequest, _ metadata.M) (ResponseRecver, error)
  • func (m *Mock) Name() string
  • func (m *Mock) RequestRecords() []openai.ChatCompletionRequest
• type MockData
  • func MockChatCompletionResponse(str ...string) MockData
  • func MockChatCompletionStreamResponse(str ...string) MockData
• type ResponseRecver

Variables

var ErrNotExistsProvider = errors.New("llm provider does not exist")

ErrNotExistsProvider is the error when the provider does not exist

Functions

func ListProviders

func ListProviders() []string

ListProviders returns the list of llm providers

func RegisterProvider

func RegisterProvider(provider LLMProvider)

RegisterProvider registers the llm provider

Types

type LLMProvider

type LLMProvider interface {
	// Name returns the name of the llm provider
	Name() string
	// GetChatCompletions returns the chat completions.
	GetChatCompletions(context.Context, openai.ChatCompletionRequest, metadata.M) (openai.ChatCompletionResponse, error)
	// GetChatCompletionsStream returns the chat completions in stream.
	GetChatCompletionsStream(context.Context, openai.ChatCompletionRequest, metadata.M) (ResponseRecver, error)
}

LLMProvider provides an interface to the llm providers

func GetProvider

func GetProvider(name string) (LLMProvider, error)

GetProvider returns the llm provider by name

type Mock

type Mock struct {
	// contains filtered or unexported fields
}

Mock implements the ai.Provider interface. And it can be used for recording requests and mocking responses.

func NewMock

func NewMock(name string, data ...MockData) (*Mock, error)

NewMock returns a mock provider.

func (*Mock) GetChatCompletions

func (m *Mock) GetChatCompletions(_ context.Context, req openai.ChatCompletionRequest, _ metadata.M) (openai.ChatCompletionResponse, error)

GetChatCompletions implements the ai.Provider interface.

func (*Mock) GetChatCompletionsStream

func (m *Mock) GetChatCompletionsStream(_ context.Context, req openai.ChatCompletionRequest, _ metadata.M) (ResponseRecver, error)

GetChatCompletionsStream implements the ai.Provider interface.

func (*Mock) Name

func (m *Mock) Name() string

Name returns the provider name.

func (*Mock) RequestRecords

func (m *Mock) RequestRecords() []openai.ChatCompletionRequest

RequestRecords returns the request records.

type MockData

type MockData interface {
	// contains filtered or unexported methods
}

MockData supplys mock response data to the mock provider.

func MockChatCompletionResponse

func MockChatCompletionResponse(str ...string) MockData

MockChatCompletionResponse supplys mock response data to the mock provider.

func MockChatCompletionStreamResponse

func MockChatCompletionStreamResponse(str ...string) MockData

MockChatCompletionStreamResponse supplys mock response data in form of stream to the mock provider.

type ResponseRecver

type ResponseRecver interface {
	// Recv is the receive function.
	Recv() (response openai.ChatCompletionStreamResponse, err error)
}

ResponseRecver receives stream response.