models

Documentation

Overview

This package contains test intended to be used by the implementations of the Querier, ChatQuerier and StreamCompleter interfaces

Index

• func ChatQuerier_Test(t *testing.T, q ChatQuerier)
• func Querier_Context_Test(t *testing.T, q Querier)
• func StreamCompleter_Test(t *testing.T, s StreamCompleter)
• type Chat
  • func (c *Chat) FirstSystemMessage() (Message, error)
  • func (c *Chat) FirstUserMessage() (Message, error)
• type ChatQuerier
• type CompletionEvent
• type Message
• type NoopEvent
• type Querier
• type StreamCompleter
• type ToolBox

Functions

func ChatQuerier_Test

func ChatQuerier_Test(t *testing.T, q ChatQuerier)

func Querier_Context_Test

func Querier_Context_Test(t *testing.T, q Querier)

func StreamCompleter_Test

func StreamCompleter_Test(t *testing.T, s StreamCompleter)

Types

type Chat

type Chat struct {
	Created  time.Time `json:"created,omitempty"`
	ID       string    `json:"id"`
	Messages []Message `json:"messages"`
}

func (*Chat) FirstSystemMessage

func (c *Chat) FirstSystemMessage() (Message, error)

FirstSystemMessage returns the first encountered Message with role 'system'

func (*Chat) FirstUserMessage

func (c *Chat) FirstUserMessage() (Message, error)

type ChatQuerier

type ChatQuerier interface {
	Querier
	TextQuery(context.Context, Chat) (Chat, error)
}

type CompletionEvent

type CompletionEvent any

type Message

type Message struct {
	Role       string       `json:"role"`
	Content    string       `json:"content,omitempty"`
	ToolCalls  []tools.Call `json:"tool_calls,omitempty"`
	ToolCallID string       `json:"tool_call_id,omitempty"`
}

type NoopEvent

type NoopEvent struct{}

type Querier

type Querier interface {
	Query(ctx context.Context) error
}

type StreamCompleter

type StreamCompleter interface {
	// Setup the stream completer, do things like init http.Client/websocket etc
	// Will be called synchronously. Should return error if setup fails
	Setup() error

	// StreamCompletions and return a channel which sends CompletionsEvents.
	// The CompletionEvents should be a string, an error, NoopEvent or a models.Call. If there is
	// a catastrophic error, return the error and close the channel.
	StreamCompletions(context.Context, Chat) (chan CompletionEvent, error)
}

type ToolBox

type ToolBox interface {
	// RegisterTool registers a tool to the ToolBox
	RegisterTool(tools.AiTool)
}

A ToolBox can register tools which later on will be added to the chat completion queries