llm

type Blackbox ¶ added in v0.1.18

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
	Prompt(ctx context.Context, opts PrompterOpts) (string, error)
}

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

type ClientOption ¶ added in v0.1.8

type ClientOption func(*ClientOptions)

func WithAPIKey(x string) ClientOption

func WithLoaded(x Loaded) ClientOption

func WithModel(x string) ClientOption

func WithURL(x string) ClientOption

type ClientOptions ¶ added in v0.1.8

type ClientOptions struct {
	Loaded
	URL   string
	Model string
}

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

type DefaultTool ¶ added in v0.1.11

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

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

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

type Dependencies ¶ added in v0.1.11

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

type Loaded ¶ added in v0.1.122

type Loaded struct {
	APIKey string
}

type Message ¶

type Message struct {
	Role    string `json:"role"`
	Content string `json:"content"`
}

Message represents a message in the conversation. For contextual messages, see:

• https://docs.x.ai/docs/guides/chat#conversations

type MessageRole ¶

type MessageRole = string

MessageRole represents the role of a message.

const (
	// MessageRoleSystem is the role for the system message.
	MessageRoleSystem MessageRole = "system"
	// MessageRoleUser is the role for the user message.
	MessageRoleUser MessageRole = "user"
	// MessageRoleAssistant is the role for the assistant message.
	MessageRoleAssistant MessageRole = "assistant"
	// GrokChatCompletionURL is the URL for the Grok LLM API.
	GrokChatCompletionURL = "https://api.x.ai/v1/chat/completions"
	// Grok2LatestModel is the latest model for the Grok LLM.
	Grok2LatestModel = "grok-2-latest"
)

type PrompterOpts ¶

type PrompterOpts struct {
	SystemPrompt   string          // The system prompt for the LLM.
	UserPrompt     string          // The user prompt for the LLM.
	Context        []Message       // The context for the LLM.
	Temperature    float64         // The temperature for the LLM.
	ResponseFormat *ResponseFormat // The response format for the LLM.
	AdditionalOpts map[string]any  // Additional options for the LLM to be implemented by prompters, optionally.
}

PrompterOpts represents the options for the Prompter.

type ResponseFormat ¶

type ResponseFormat struct {
	Type       string        `json:"type"`
	JSONSchema *schemaFormat `json:"json_schema,omitempty"`
}

ResponseFormat represents the response format customization.