types

Documentation

Index

• Constants
• func FirstSet[T comparable](in ...T) (result T)
• type BuiltinFunc
• type CompletionFunctionCall
• type CompletionFunctionDefinition
• type CompletionMessage
  • func (in CompletionMessage) IsToolCall() bool
  • func (in CompletionMessage) String() string
• type CompletionMessageRoleType
• type CompletionRequest
• type CompletionStatus
• type CompletionTool
• type CompletionToolCall
• type ContentPart
  • func Text(text string) []ContentPart
• type JSONSchema
  • func ObjectSchema(kv ...string) *JSONSchema
• type Parameters
• type Program
• type Property
• type Repo
• type Tool
  • func (t Tool) IsCommand() bool
  • func (t Tool) IsDaemon() bool
  • func (t Tool) IsHTTP() bool
  • func (t Tool) String() string
• type ToolSet
• type ToolSource
  • func (t ToolSource) String() string
• type Type
  • func (t *Type) MarshalJSON() ([]byte, error)
  • func (t *Type) UnmarshalJSON(data []byte) error

Constants

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

Chat message role defined by the OpenAI API.

const (
	DaemonPrefix  = "#!sys.daemon"
	CommandPrefix = "#!"
)

Functions

func FirstSet

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

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"`
	Domain      string      `json:"domain,omitempty"`
	Parameters  *JSONSchema `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

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 JSONSchema

type JSONSchema struct {
	Property

	ID         string                `json:"$id,omitempty"`
	Title      string                `json:"title,omitempty"`
	Properties map[string]Property   `json:"properties"`
	Required   []string              `json:"required,omitempty"`
	Defs       map[string]JSONSchema `json:"defs,omitempty"`

	AdditionalProperties bool `json:"additionalProperties,omitempty"`
}

func ObjectSchema

func ObjectSchema(kv ...string) *JSONSchema

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"`
	JSONResponse   bool        `json:"jsonResponse,omitempty"`
	Temperature    *float32    `json:"temperature,omitempty"`
	Cache          *bool       `json:"cache,omitempty"`
	InternalPrompt *bool       `json:"internalPrompt"`
	Arguments      *JSONSchema `json:"arguments,omitempty"`
	Tools          []string    `json:"tools,omitempty"`
	Export         []string    `json:"export,omitempty"`
}

type Program

type Program struct {
	Name        string            `json:"name,omitempty"`
	EntryToolID string            `json:"entryToolId,omitempty"`
	ToolSet     ToolSet           `json:"toolSet,omitempty"`
	Exports     map[string]string `json:"exports,omitempty"`
}

type Property

type Property struct {
	Description string       `json:"description,omitempty"`
	Type        string       `json:"type,omitempty"`
	Ref         string       `json:"$ref,omitempty"`
	Items       []JSONSchema `json:"items,omitempty"`
}

type Repo

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) IsCommand

func (t Tool) IsCommand() bool

func (Tool) IsDaemon

func (t Tool) IsDaemon() bool

func (Tool) IsHTTP

func (t Tool) IsHTTP() 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

type Type

type Type []string

func (*Type) MarshalJSON

func (t *Type) MarshalJSON() ([]byte, error)

func (*Type) UnmarshalJSON

func (t *Type) UnmarshalJSON(data []byte) error