types

package
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 12, 2024 License: Apache-2.0 Imports: 11 Imported by: 7

Documentation

Index

Constants

View Source
const (
	CompletionMessageRoleTypeUser      = CompletionMessageRoleType("user")
	CompletionMessageRoleTypeSystem    = CompletionMessageRoleType("system")
	CompletionMessageRoleTypeAssistant = CompletionMessageRoleType("assistant")
	CompletionMessageRoleTypeTool      = CompletionMessageRoleType("tool")
)

Chat message role defined by the OpenAI API.

View Source
const (
	DaemonPrefix  = "#!sys.daemon"
	OpenAPIPrefix = "#!sys.openapi"
	CommandPrefix = "#!"
)

Variables

This section is empty.

Functions

func FirstSet

func FirstSet[T comparable](in ...T) (result T)

func ObjectSchema

func ObjectSchema(kv ...string) *openapi3.Schema

func PickToolName added in v0.4.0

func PickToolName(toolName string, existing map[string]struct{}) string

func ToolNormalizer added in v0.4.0

func ToolNormalizer(tool string) string

Types

type BuiltinFunc

type BuiltinFunc func(ctx context.Context, env []string, input string) (string, error)

type CompletionFunctionCall

type CompletionFunctionCall struct {
	Name      string `json:"name,omitempty"`
	Arguments string `json:"arguments,omitempty"`
}

type CompletionFunctionDefinition

type CompletionFunctionDefinition struct {
	ToolID      string           `json:"toolID,omitempty"`
	Name        string           `json:"name"`
	Description string           `json:"description,omitempty"`
	Parameters  *openapi3.Schema `json:"parameters"`
}

type CompletionMessage

type CompletionMessage struct {
	Role    CompletionMessageRoleType `json:"role,omitempty"`
	Content []ContentPart             `json:"content,omitempty" column:"name=Message,jsonpath=.spec.content"`
	// ToolCall should be set for only messages of type "tool" and Content[0].Text should be set as the
	// result of the call describe by this field
	ToolCall *CompletionToolCall `json:"toolCall,omitempty"`
}

func (CompletionMessage) IsToolCall

func (in CompletionMessage) IsToolCall() bool

func (CompletionMessage) String

func (in CompletionMessage) String() string

type CompletionMessageRoleType

type CompletionMessageRoleType string

type CompletionRequest

type CompletionRequest struct {
	Model                string
	InternalSystemPrompt *bool
	Tools                []CompletionTool
	Messages             []CompletionMessage
	MaxTokens            int
	Temperature          *float32
	JSONResponse         bool
	Grammar              string
	Cache                *bool
}

type CompletionStatus added in v0.1.4

type CompletionStatus struct {
	CompletionID    string
	Request         any
	Response        any
	Cached          bool
	Chunks          any
	PartialResponse *CompletionMessage
}

type CompletionTool

type CompletionTool struct {
	Function CompletionFunctionDefinition `json:"function,omitempty"`
}

type CompletionToolCall

type CompletionToolCall struct {
	Index    *int                   `json:"index,omitempty"`
	ID       string                 `json:"id,omitempty"`
	Function CompletionFunctionCall `json:"function,omitempty"`
}

type ContentPart

type ContentPart struct {
	Text     string              `json:"text,omitempty"`
	ToolCall *CompletionToolCall `json:"toolCall,omitempty"`
}

func Text

func Text(text string) []ContentPart

type ErrToolNotFound added in v0.4.0

type ErrToolNotFound struct {
	ToolName string
}

func NewErrToolNotFound added in v0.5.0

func NewErrToolNotFound(toolName string) *ErrToolNotFound

func (*ErrToolNotFound) Error added in v0.4.0

func (e *ErrToolNotFound) Error() string

type Parameters

type Parameters struct {
	Name           string           `json:"name,omitempty"`
	Description    string           `json:"description,omitempty"`
	MaxTokens      int              `json:"maxTokens,omitempty"`
	ModelName      string           `json:"modelName,omitempty"`
	ModelProvider  bool             `json:"modelProvider,omitempty"`
	JSONResponse   bool             `json:"jsonResponse,omitempty"`
	Temperature    *float32         `json:"temperature,omitempty"`
	Cache          *bool            `json:"cache,omitempty"`
	InternalPrompt *bool            `json:"internalPrompt"`
	Arguments      *openapi3.Schema `json:"arguments,omitempty"`
	Tools          []string         `json:"tools,omitempty"`
	Context        []string         `json:"context,omitempty"`
	ExportContext  []string         `json:"exportContext,omitempty"`
	Export         []string         `json:"export,omitempty"`
	Credentials    []string         `json:"credentials,omitempty"`
	Blocking       bool             `json:"-"`
}

type Program

type Program struct {
	Name        string  `json:"name,omitempty"`
	EntryToolID string  `json:"entryToolId,omitempty"`
	ToolSet     ToolSet `json:"toolSet,omitempty"`
}

func (Program) GetCompletionTools added in v0.4.0

func (p Program) GetCompletionTools() (result []CompletionTool, err error)

func (Program) GetContextToolIDs added in v0.5.0

func (p Program) GetContextToolIDs(toolID string) (result []string, _ error)

func (Program) SetBlocking added in v0.3.0

func (p Program) SetBlocking() Program

func (Program) TopLevelTools added in v0.4.0

func (p Program) TopLevelTools() (result []Tool)

type Repo added in v0.2.0

type Repo struct {
	// VCS The VCS type, such as "git"
	VCS string
	// The URL where the VCS repo can be found
	Root string
	// The path in the repo of this source. This should refer to a directory and not the actual file
	Path string
	// The filename of the source in the repo, relative to Path
	Name string
	// The revision of this source
	Revision string
}

type Tool

type Tool struct {
	Parameters   `json:",inline"`
	Instructions string `json:"instructions,omitempty"`

	ID          string            `json:"id,omitempty"`
	ToolMapping map[string]string `json:"toolMapping,omitempty"`
	LocalTools  map[string]string `json:"localTools,omitempty"`
	BuiltinFunc BuiltinFunc       `json:"-"`
	Source      ToolSource        `json:"source,omitempty"`
	WorkingDir  string            `json:"workingDir,omitempty"`
}

func (Tool) GetCompletionTools added in v0.4.0

func (t Tool) GetCompletionTools(prg Program) (result []CompletionTool, err error)

func (Tool) GetToolIDsFromNames added in v0.5.0

func (t Tool) GetToolIDsFromNames(names []string) (result []string, _ error)

func (Tool) IsCommand

func (t Tool) IsCommand() bool

func (Tool) IsDaemon

func (t Tool) IsDaemon() bool

func (Tool) IsHTTP

func (t Tool) IsHTTP() bool

func (Tool) IsOpenAPI added in v0.4.0

func (t Tool) IsOpenAPI() bool

func (Tool) String

func (t Tool) String() string

type ToolSet

type ToolSet map[string]Tool

type ToolSource

type ToolSource struct {
	Location string `json:"location,omitempty"`
	LineNo   int    `json:"lineNo,omitempty"`
	Repo     *Repo  `json:"repo,omitempty"`
}

func (ToolSource) String

func (t ToolSource) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL