llm

Documentation

Index

• type Blackbox
• type Client
  • func NewClient(d Dependencies, opts ClientOptions) (Client, error)
• type ClientOption
  • func WithAPIKey(x string) ClientOption
  • func WithLoaded(x Loaded) ClientOption
  • func WithModel(x string) ClientOption
  • func WithURL(x string) ClientOption
• type ClientOptions
  • func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions
• type DefaultTool
  • func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool
  • func (d *DefaultTool) Prompt(ctx context.Context, opts contract.PrompterOpts) (string, error)
• type Dependencies
• type Loaded
• type Tool

Types

type Blackbox

type Blackbox interface {
	contract.Reader
}

WARN: Methods from this interface require black-box testing because they internally call package-level functions (e.g., http.NewRequest) that are not easily mockable or stubbable. While we have access to their implementation, mocking or stubbing these functions is not practical. As a result, these methods are best tested using black-box testing techniques, such as input-based testing, where explicit error scenarios are triggered. Alternatively, these methods can also be tested using function variables.

type Client

type Client interface {
	Blackbox
	contract.Prompter
}

func NewClient

func NewClient(d Dependencies, opts ClientOptions) (Client, error)

type ClientOption

type ClientOption func(*ClientOptions)

func WithAPIKey

func WithAPIKey(x string) ClientOption

func WithLoaded

func WithLoaded(x Loaded) ClientOption

func WithModel

func WithModel(x string) ClientOption

func WithURL

func WithURL(x string) ClientOption

type ClientOptions

type ClientOptions struct {
	Loaded
	URL   string
	Model string
}

func ApplyClientOptions

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool

type DefaultTool struct {
	T *contract.Tool[Client]
}

func NewTool

func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool

func (*DefaultTool) Prompt

func (d *DefaultTool) Prompt(ctx context.Context, opts contract.PrompterOpts) (string, error)

Prompt sends a prompt to the LLM and retrieves the response.

type Dependencies

type Dependencies struct {
	M  contract.Marshaler
	U  contract.Unmarshaler
	HR contract.HTTPRequester
	HD contract.HTTPDoer
}

type Loaded

type Loaded struct {
	APIKey string
}

type Tool

type Tool interface {
	contract.Prompter
}