engine

Documentation

Index

• Constants
• func CloseDaemons()
• func IsChatFinishMessage(msg string) error
• func SetPorts(start, end int64)
• func WithToolCategory(ctx context.Context, toolCategory ToolCategory) context.Context
• type Call
• type CallContext
• type CallResult
• type ChatHistory
• type ChatHistoryCall
• type Context
  • func FromContext(ctx context.Context) (*Context, bool)
  • func NewContext(ctx context.Context, prg *types.Program, input string) (Context, error)
  • func (c *Context) CurrentAgent() types.ToolReference
  • func (c *Context) GetCallContext() *CallContext
  • func (c *Context) MarshalJSON() ([]byte, error)
  • func (c *Context) ParentID() string
  • func (c *Context) SubCallContext(ctx context.Context, input, toolID, callID string, toolCategory ToolCategory) (Context, error)
  • func (c *Context) UnmarshalJSON([]byte) error
  • func (c *Context) WrappedContext() context.Context
• type Engine
  • func (e *Engine) Continue(ctx Context, state *State, results ...CallResult) (*Return, error)
  • func (e *Engine) Start(ctx Context, input string) (ret *Return, _ error)
• type ErrChatFinish
  • func (e *ErrChatFinish) Error() string
• type InputContext
• type Model
• type Ports
• type Return
• type RuntimeManager
• type State
• type ToolCategory
  • func ToolCategoryFromContext(ctx context.Context) ToolCategory

Constants

const DaemonURLSuffix = ".daemon.gptscript.local"

Functions

func CloseDaemons

func CloseDaemons()

func IsChatFinishMessage

func IsChatFinishMessage(msg string) error

func SetPorts

func SetPorts(start, end int64)

func WithToolCategory

func WithToolCategory(ctx context.Context, toolCategory ToolCategory) context.Context

Types

type Call

type Call struct {
	Missing bool   `json:"missing,omitempty"`
	ToolID  string `json:"toolID,omitempty"`
	Input   string `json:"input,omitempty"`
}

type CallContext

type CallContext struct {
	ToolName    string `json:"toolName,omitempty"`
	ParentID    string `json:"parentID,omitempty"`
	DisplayText string `json:"displayText,omitempty"`
	// contains filtered or unexported fields
}

type CallResult

type CallResult struct {
	ToolID string `json:"toolID,omitempty"`
	CallID string `json:"callID,omitempty"`
	Result string `json:"result,omitempty"`
	User   string `json:"user,omitempty"`
}

type ChatHistory

type ChatHistory struct {
	History []ChatHistoryCall `json:"history,omitempty"`
}

type ChatHistoryCall

type ChatHistoryCall struct {
	ID         string                  `json:"id,omitempty"`
	Tool       types.Tool              `json:"tool,omitempty"`
	Completion types.CompletionRequest `json:"completion,omitempty"`
}

type Context

type Context struct {
	Ctx           context.Context
	Parent        *Context
	LastReturn    *Return
	CurrentReturn *Return
	Program       *types.Program
	// Input is saved only so that we can render display text, don't use otherwise
	Input string
	// contains filtered or unexported fields
}

func FromContext

func FromContext(ctx context.Context) (*Context, bool)

func NewContext

func NewContext(ctx context.Context, prg *types.Program, input string) (Context, error)

func (*Context) CurrentAgent

func (c *Context) CurrentAgent() types.ToolReference

func (*Context) GetCallContext

func (c *Context) GetCallContext() *CallContext

func (*Context) MarshalJSON

func (c *Context) MarshalJSON() ([]byte, error)

func (*Context) ParentID

func (c *Context) ParentID() string

func (*Context) SubCallContext

func (c *Context) SubCallContext(ctx context.Context, input, toolID, callID string, toolCategory ToolCategory) (Context, error)

func (*Context) UnmarshalJSON

func (c *Context) UnmarshalJSON([]byte) error

func (*Context) WrappedContext

func (c *Context) WrappedContext() context.Context

type Engine

type Engine struct {
	Model          Model
	RuntimeManager RuntimeManager
	Env            []string
	Progress       chan<- types.CompletionStatus
}

func (*Engine) Continue

func (e *Engine) Continue(ctx Context, state *State, results ...CallResult) (*Return, error)

func (*Engine) Start

func (e *Engine) Start(ctx Context, input string) (ret *Return, _ error)

type ErrChatFinish

type ErrChatFinish struct {
	Message string
}

func (*ErrChatFinish) Error

func (e *ErrChatFinish) Error() string

type InputContext

type InputContext struct {
	ToolID  string `json:"toolID,omitempty"`
	Content string `json:"content,omitempty"`
}

type Model

type Model interface {
	Call(ctx context.Context, messageRequest types.CompletionRequest, status chan<- types.CompletionStatus) (*types.CompletionMessage, error)
}

type Ports

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

type Return

type Return struct {
	State  *State          `json:"state,omitempty"`
	Calls  map[string]Call `json:"calls,omitempty"`
	Result *string         `json:"result,omitempty"`
}

type RuntimeManager

type RuntimeManager interface {
	GetContext(ctx context.Context, tool types.Tool, cmd, env []string) (string, []string, error)
	EnsureCredentialHelpers(ctx context.Context) error
	SetUpCredentialHelpers(ctx context.Context, cliCfg *config.CLIConfig, env []string) error
}

type State

type State struct {
	Input      string                              `json:"input,omitempty"`
	Completion types.CompletionRequest             `json:"completion,omitempty"`
	Pending    map[string]types.CompletionToolCall `json:"pending,omitempty"`
	Results    map[string]CallResult               `json:"results,omitempty"`
}

type ToolCategory

type ToolCategory string

const (
	ProviderToolCategory   ToolCategory = "provider"
	CredentialToolCategory ToolCategory = "credential"
	ContextToolCategory    ToolCategory = "context"
	InputToolCategory      ToolCategory = "input"
	OutputToolCategory     ToolCategory = "output"
	NoCategory             ToolCategory = ""
)

func ToolCategoryFromContext

func ToolCategoryFromContext(ctx context.Context) ToolCategory