dispatch

Documentation

Index

• func FunctionInputToTool(fi FunctionInput) openai.Tool
• type Dispatcher
• type DummyDispatcher
  • func NewDummyDispatcher[T any]() *DummyDispatcher[T]
  • func (d *DummyDispatcher[T]) Prompt(ctx context.Context, prompt string) (T, error)
  • func (d *DummyDispatcher[T]) PromptTemplate(ctx context.Context, template *template.Template, values interface{}) (T, error)
• type FunctionInput
  • func StructToJsonSchema(functionName string, functionDescription string, inputStruct interface{}) FunctionInput
  • func StructToJsonSchemaGeneric[T any](functionName string, functionDescription string) FunctionInput
• type OAITool
• type OpenAIDispatcher
  • func NewOpenAIDispatcher[T any](name, description, systemPrompt string, completer gollum.ChatCompleter, ...) *OpenAIDispatcher[T]
  • func (d *OpenAIDispatcher[T]) Prompt(ctx context.Context, prompt string) (T, error)
  • func (d *OpenAIDispatcher[T]) PromptTemplate(ctx context.Context, template *template.Template, values interface{}) (T, error)
• type OpenAIDispatcherConfig

Functions

func FunctionInputToTool

func FunctionInputToTool(fi FunctionInput) openai.Tool

Types

type Dispatcher

type Dispatcher[T any] interface {
	// Prompt generates an object of type T from the given prompt.
	Prompt(ctx context.Context, prompt string) (T, error)
	// PromptTemplate generates an object of type T from a given template.
	// The prompt is then a template string that is rendered with the given values.
	PromptTemplate(ctx context.Context, template *template.Template, values interface{}) (T, error)
}

type DummyDispatcher

type DummyDispatcher[T any] struct{}

func NewDummyDispatcher

func NewDummyDispatcher[T any]() *DummyDispatcher[T]

func (*DummyDispatcher[T]) Prompt

func (d *DummyDispatcher[T]) Prompt(ctx context.Context, prompt string) (T, error)

func (*DummyDispatcher[T]) PromptTemplate

func (d *DummyDispatcher[T]) PromptTemplate(ctx context.Context, template *template.Template, values interface{}) (T, error)

type FunctionInput

type FunctionInput struct {
	Name        string `json:"name"`
	Description string `json:"description,omitempty"`
	Parameters  any    `json:"parameters"`
}

func StructToJsonSchema

func StructToJsonSchema(functionName string, functionDescription string, inputStruct interface{}) FunctionInput

func StructToJsonSchemaGeneric

func StructToJsonSchemaGeneric[T any](functionName string, functionDescription string) FunctionInput

type OAITool

type OAITool struct {
	// Type is always "function" for now.
	Type     string        `json:"type"`
	Function FunctionInput `json:"function"`
}

type OpenAIDispatcher

type OpenAIDispatcher[T any] struct {
	*OpenAIDispatcherConfig
	// contains filtered or unexported fields
}

OpenAIDispatcher dispatches to any OpenAI compatible model. For any type T and prompt, it will generate and parse the response into T.

func NewOpenAIDispatcher

func NewOpenAIDispatcher[T any](name, description, systemPrompt string, completer gollum.ChatCompleter, cfg *OpenAIDispatcherConfig) *OpenAIDispatcher[T]

func (*OpenAIDispatcher[T]) Prompt

func (d *OpenAIDispatcher[T]) Prompt(ctx context.Context, prompt string) (T, error)

func (*OpenAIDispatcher[T]) PromptTemplate

func (d *OpenAIDispatcher[T]) PromptTemplate(ctx context.Context, template *template.Template, values interface{}) (T, error)

PromptTemplate generates an object of type T from a given template. This is mostly a convenience wrapper around Prompt.

type OpenAIDispatcherConfig

type OpenAIDispatcherConfig struct {
	Model       *string
	Temperature *float32
	MaxTokens   *int
}