builtin_tools

Documentation

Index

• Constants
• Variables
• func LoadKnowledgeBaseTool(knowledge *knowledgebase.KnowledgeBase) (tool.Tool, error)
• func LoadLongMemoryTool() (tool.Tool, error)
• func NewImageGenerateTool(config *ImageGenerateConfig) (tool.Tool, error)
• func NewLLMShieldPlugins() (*plugin.Plugin, error)
• func NewMcpRouter() tool.Toolset
• func NewRunCodeSandboxTool() (tool.Tool, error)
• func NewVideoGenerateTool(config *VideoGenerateConfig) (tool.Tool, error)
• type Args
• type Decision
• type DecisionDetail
• type GenerateImagesRequest
• type GenerateVideosRequest
• type ImageGenerateConfig
• type ImageGenerateToolChanelMessage
• type ImageGenerateToolRequest
• type ImageGenerateToolResult
• type ImageResult
• type KnowledgeBaseResult
• type LLMShieldClient
  • func NewLLMShieldClient(timeout int) (*LLMShieldClient, error)
• type LLMShieldData
• type LLMShieldResult
• type Matches
• type PermitInfo
• type QueryKnowledgeReq
• type ReplaceDetail
• type ResponseMetadata
• type Result
• type RiskInfo
• type Risks
• type RunCodeArgs
• type VideoGenerateConfig
• type VideoGenerateResult
• type VideoGenerateToolChanelMessage
• type VideoGenerateToolRequest
• type VideoResult

Constants

const (
	ImageGenerateSuccessStatus = "success"
	ImageGenerateErrorStatus   = "error"
)

const (
	DefaultScheme  = "https"
	DefaultTimeout = 600
)

const (
	VideoGenerateSuccessStatus = "success"
	VideoGenerateErrorStatus   = "error"
)

Variables

var (
	ErrInvalidAppID  = errors.New("LLM Shield App ID is not configured. Please configure it via environment TOOL_LLM_SHIELD_APP_ID")
	ErrInvalidApiKey = errors.New("LLM Shield auth invalid, Please configure it via environment TOOL_LLM_SHIELD_API_KEY or VOLCENGINE_ACCESS_KEY and VOLCENGINE_SECRET_KEY")
)

var CategoryMap = map[string]string{
	"101": "Model Misuse",
	"103": "Sensitive Information",
	"104": "Prompt Injection",
	"106": "General Topic Control",
	"107": "Computational Resource Consumption",
}

var ErrInvalidToolID = errors.New("agentkit tool id is invalid")

Functions

func LoadKnowledgeBaseTool

func LoadKnowledgeBaseTool(knowledge *knowledgebase.KnowledgeBase) (tool.Tool, error)

LoadKnowledgeBaseTool Loads the knowledgebase tools from a backend. Args: query: The query to load the knowledgebase for. Returns: A list of knowledge base results.

func LoadLongMemoryTool

func LoadLongMemoryTool() (tool.Tool, error)

func NewImageGenerateTool

func NewImageGenerateTool(config *ImageGenerateConfig) (tool.Tool, error)

func NewLLMShieldPlugins

func NewLLMShieldPlugins() (*plugin.Plugin, error)

func NewMcpRouter

func NewMcpRouter() tool.Toolset

func NewRunCodeSandboxTool

func NewRunCodeSandboxTool() (tool.Tool, error)

func NewVideoGenerateTool

func NewVideoGenerateTool(config *VideoGenerateConfig) (tool.Tool, error)

Types

type Args

type Args struct {
	Query string `json:"query" jsonschema:"The query to search for in the memory."`
}

type Decision

type Decision struct {
	DecisionType   int             `json:"DecisionType"`
	DecisionDetail *DecisionDetail `json:"DecisionDetail"`
	HitStrategyIDs []string        `json:"HitStrategyIDs"`
}

type DecisionDetail

type DecisionDetail struct {
	BlockDetail   map[string]interface{} `json:"BlockDetail"`
	ReplaceDetail *ReplaceDetail         `json:"ReplaceDetail"`
}

type GenerateImagesRequest

type GenerateImagesRequest struct {
	TaskType                  string      `json:"task_type"`
	Prompt                    string      `json:"prompt"`
	Size                      string      `json:"size,omitempty"`
	ResponseFormat            string      `json:"response_format,omitempty"`
	Watermark                 *bool       `json:"watermark,omitempty"`
	Image                     interface{} `json:"image,omitempty"`
	SequentialImageGeneration string      `json:"sequential_image_generation,omitempty"`
	MaxImages                 int         `json:"max_images,omitempty"`
}

type GenerateVideosRequest

type GenerateVideosRequest struct {
	VideoName  string  `json:"video_name"`
	Prompt     string  `json:"prompt"`
	FirstFrame *string `json:"first_frame,omitempty"`
	LastFrame  *string `json:"last_frame,omitempty"`
}

type ImageGenerateConfig

type ImageGenerateConfig struct {
	ModelName string
	APIKey    string
	BaseURL   string
}

type ImageGenerateToolChanelMessage

type ImageGenerateToolChanelMessage struct {
	Status       string
	ErrorMessage string
	Result       *ImageResult
}

type ImageGenerateToolRequest

type ImageGenerateToolRequest struct {
	Tasks []GenerateImagesRequest `json:"tasks"`
}

type ImageGenerateToolResult

type ImageGenerateToolResult struct {
	SuccessList []*ImageResult `json:"success_list,omitempty"`
	ErrorList   []*ImageResult `json:"error_list,omitempty"`
	Status      string
}

type ImageResult

type ImageResult struct {
	ImageName string `json:"image_name"`
	Url       string `json:"url"`
}

type KnowledgeBaseResult

type KnowledgeBaseResult struct {
	Result []ktypes.KnowledgeEntry `json:"result,omitempty"`
}

type LLMShieldClient

type LLMShieldClient struct {
	URL     string
	Region  string
	AppID   string
	APIKey  string
	Timeout int
}

func NewLLMShieldClient

func NewLLMShieldClient(timeout int) (*LLMShieldClient, error)

type LLMShieldData

type LLMShieldData struct {
	MsgID         string      `json:"MsgID"`
	RiskInfo      *RiskInfo   `json:"RiskInfo"`
	Decision      *Decision   `json:"Decision"`
	PermitInfo    *PermitInfo `json:"PermitInfo"`
	ContentInfo   string      `json:"ContentInfo"`
	Degraded      bool        `json:"Degraded"`
	DegradeReason string      `json:"DegradeReason"`
}

type LLMShieldResult

type LLMShieldResult struct {
	ResponseMetadata *ResponseMetadata `json:"ResponseMetadata"`
	Result           *LLMShieldData    `json:"Result"`
}

type Matches

type Matches struct {
	Word   string `json:"Word"`
	Source int    `json:"Source"`
}

type PermitInfo

type PermitInfo struct {
	Permits interface{} `json:"Permits"`
}

type QueryKnowledgeReq

type QueryKnowledgeReq struct {
	Query string `json:"query" jsonschema:"The query for loading the knowledge base for this tools"`
}

type ReplaceDetail

type ReplaceDetail struct {
	Replacement interface{} `json:"Replacement"`
}

type ResponseMetadata

type ResponseMetadata struct {
	RequestID string `json:"RequestId"`
	Service   string `json:"Service"`
	Region    string `json:"Region"`
	Action    string `json:"Action"`
	Version   string `json:"Version"`
}

type Result

type Result struct {
	Results []string `json:"results"`
}

type RiskInfo

type RiskInfo struct {
	Risks []*Risks `json:"Risks"`
}

type Risks

type Risks struct {
	Category string     `json:"Category"`
	Label    string     `json:"Label"`
	Prob     float64    `json:"Prob,omitempty"`
	Matches  []*Matches `json:"Matches,omitempty"`
}

type RunCodeArgs

type RunCodeArgs struct {
	Code     string `json:"code" jsonschema:"The code to run."`
	Language string `json:"language" jsonschema:"The programming language of the code. Language must be one of the supported languages: python3."`
	Timeout  uint   `json:"timeout" jsonschema:"The timeout in seconds for the code execution. Defaults to 30."`
}

type VideoGenerateConfig

type VideoGenerateConfig struct {
	ModelName string
	APIKey    string
	BaseURL   string
}

type VideoGenerateResult

type VideoGenerateResult struct {
	SuccessList []*VideoResult `json:"success_list,omitempty"`
	ErrorList   []*VideoResult `json:"error_list,omitempty"`
	Status      string
}

type VideoGenerateToolChanelMessage

type VideoGenerateToolChanelMessage struct {
	Status       string
	ErrorMessage string
	Result       *VideoResult
}

type VideoGenerateToolRequest

type VideoGenerateToolRequest struct {
	Params    []GenerateVideosRequest `json:"params"`
	BatchSize int                     `json:"batch_size,omitempty"`
}

type VideoResult

type VideoResult struct {
	VideoName string `json:"video_name"`
	Url       string `json:"video_url"`
}