Package core.agent

• Package core.agent
  • interface Agent
    • func asyncChat
    • func chat
    • prop description
    • prop executor
    • prop interceptor
    • prop memory
    • prop model
    • prop name
    • prop retriever
    • prop systemPrompt
    • prop temperature
    • prop toolManager
  • class AgentExecutionException
    • func init
  • class AgentExecutionInfo
    • let dialog
    • func init
    • func init
    • let retrievalInfo
    • prop verboseInfo
  • interface AgentExecutor
    • func asyncRun
    • func run
  • interface AgentGroup
    • func asyncChat
    • func chat
    • func chat
    • func operator []
  • class AgentRequest
    • let dialog
    • func init
    • let question
    • let verbose
  • struct AgentResponse
    • let content
    • let execInfo
    • func init
    • func init
  • class AsyncAgentResponse
    • prop content
    • let execInfo
    • func init
    • func init
    • func next
  • class Interceptor
    • func init
  • enum InterceptorMode
    • enumeration Always
    • enumeration Conditional
    • enumeration Periodic

interface Agent

func asyncChat

func asyncChat(request: AgentRequest): AsyncAgentResponse

• 描述: 查询代理并以流的形式获取答案
• 参数:
  • request: AgentRequest, 代理请求

func chat

func chat(request: AgentRequest): AgentResponse

• 描述: 查询代理并获取答案，可能会抛出AgentExecutionException异常
• 参数:
  • request: AgentRequest, 代理请求

prop description

prop description: String

• 描述: 代理的功能描述

prop executor

mut prop executor: AgentExecutor

• 描述: 底层的代理执行器

prop interceptor

mut prop interceptor: Option<Interceptor>

• 描述: 设置代理拦截器

prop memory

mut prop memory: Option<Memory>

• 描述: 代理将使用的内存

prop model

mut prop model: ChatModel

• 描述: 代理将使用的聊天模型

prop name

prop name: String

• 描述: 代理的名称

prop retriever

mut prop retriever: Option<Retriever>

• 描述: 代理可以使用的检索器

prop systemPrompt

mut prop systemPrompt: String

• 描述: 代理的系统提示

prop temperature

mut prop temperature: Option<Float64>

• 描述: 代理传递给LLM的温度参数

prop toolManager

prop toolManager: ToolManager

• 描述: 代理可以使用的工具管理器

class AgentExecutionException

func init

init(msg: String)

• 描述: 初始化AgentExecutionException异常
• 参数:
  • msg: String, 异常消息

class AgentExecutionInfo

let dialog

let dialog: Dialog

• 描述: 代理执行期间与LLM的内部对话历史

func init

public init()

• 描述: 初始化AgentExecutionInfo实例

func init

public init(dialog: Dialog)

• 描述: 使用指定的对话历史初始化AgentExecutionInfo实例
• 参数:
  • dialog: Dialog, 初始对话历史

let retrievalInfo

let retrievalInfo: ArrayList<RetrievalInfo>

• 描述: 执行期间检索到的文档

prop verboseInfo

prop verboseInfo: Iterator<String>

• 描述: 仅在AgentRequest中设置verbose: true时访问此字段

interface AgentExecutor

func asyncRun

func asyncRun(agent: Agent, request: AgentRequest): AsyncAgentResponse

• 描述: 异步执行代理运行任务
• 参数:
  • agent: Agent, 要执行的代理实例
  • request: AgentRequest, 代理请求参数

func run

func run(agent: Agent, request: AgentRequest): AgentResponse

• 描述: 执行代理运行任务
• 参数:
  • agent: Agent, 要执行的代理实例
  • request: AgentRequest, 代理请求参数

interface AgentGroup

func asyncChat

func asyncChat(request: AgentRequest): AsyncAgentResponse

• 描述: 异步与AgentGroup进行聊天交互
• 参数:
  • request: AgentRequest, 聊天请求参数

func chat

func chat(request: AgentRequest): AgentResponse

• 描述: 与AgentGroup进行聊天交互
• 参数:
  • request: AgentRequest, 聊天请求参数

func chat

func chat(request: AgentRequest, maxRound!: Int64): AgentResponse

• 描述: 与AgentGroup进行聊天交互，并指定最大轮次
• 参数:
  • request: AgentRequest, 聊天请求参数
  • maxRound!: Int64, 最大聊天轮次

func operator operator []

operator func [](memberName: String): Agent

• 描述: 根据名称查找Agent
• 参数:
  • memberName: String, Agent名称

class AgentRequest

let dialog

let dialog: Option<Dialog>

• 描述: 用户与代理之间的历史聊天记录

func init

public init(question: String, dialog!: Option<Dialog> = None, maxTool!: Int64 = 10, verbose!: Bool = false)

• 描述: 初始化AgentRequest对象
• 参数:
  • question: String, 当前用户的问题
  • dialog: Option<Dialog>, 用户与代理之间的历史聊天记录，默认为None
  • maxTool: Agent 在启用工具过滤功能时，最多使用工具的数量，默认为 10
  • verbose: Bool, 是否输出内部执行信息，默认为false

let question

let question: String

• 描述: 当前用户的问题

let maxTool

let maxTool: Int64

• 描述: Agent 在启用工具过滤功能时，最多使用工具的数量

let verbose

let verbose: Bool

• 描述: 是否输出内部执行信息

struct AgentResponse

let content

let content: String

• 描述: 执行结果

let execInfo

let execInfo: Option<AgentExecutionInfo>

• 描述: 执行过程中的内部信息

func init

public init(content: String)

• 描述: 初始化AgentResponse
• 参数:
  • content: String, 执行结果

func init

public init(content: String, execInfo!: AgentExecutionInfo)

• 描述: 初始化AgentResponse，包含执行信息
• 参数:
  • content: String, 执行结果
  • execInfo: AgentExecutionInfo, 执行过程中的内部信息

class AsyncAgentResponse

prop content

public prop content: String

• 描述: 执行结果，这是一个同步方法，会等待执行器完成

let execInfo

public let execInfo: Option<AgentExecutionInfo>

• 描述: 执行期间的内部信息

func init

public init(chunks: Iterator<String>)

• 描述: 构造函数，初始化AsyncAgentResponse实例
• 参数:
  • chunks: Iterator<String>, 字符串迭代器，用于初始化响应块

func init

public init(chunks: Iterator<String>, execInfo!: Option<AgentExecutionInfo>)

• 描述: 构造函数，初始化AsyncAgentResponse实例，并设置执行信息
• 参数:
  • chunks: Iterator<String>, 字符串迭代器，用于初始化响应块
  • execInfo: Option<AgentExecutionInfo>, 执行信息，用于记录执行过程中的内部信息

func next

override public func next(): Option<String>

• 描述: 获取下一个响应块

class Interceptor

func init

init(agent: Agent, mode!: InterceptorMode = InterceptorMode.Always)

• 描述: 初始化拦截器实例
• 参数:
  • agent: Agent, 代理实例，用于拦截操作
  • mode!: InterceptorMode, 拦截模式，默认为InterceptorMode.Always

enum InterceptorMode

Always

Always

• 描述: 总是拦截请求

Conditional

Conditional((AgentRequest) -> Bool)

• 描述: 当条件为真时拦截请求
• 参数:
  • condition: (AgentRequest) -> Bool, 拦截条件函数

Periodic

Periodic(Int64)

• 描述: 定期拦截请求
• 参数:
  • interval: Int64, 拦截间隔时间