API 概览 | 声网文档中心

client.NewClient

client.NewClient是 SDK 的入口。使用给定的请求选项创建新的 API 客户端。所有子客户端共享同一套配置。

import (
    "github.com/AgoraIO/agora-agents-go/v2/client"
    "github.com/AgoraIO/agora-agents-go/v2/option"
)

构造函数

func NewClient(opts ...option.RequestOption) *Client

创建新的 API 客户端。所有 API 能力共享同一套配置。

通过 agentkit/cn 封装接口创建客户端。agentkit/cn.NewAgoraClient(...) 内部固定使用 option.AreaCN，因此 ClientOptions 中无需传入 Area：

import (
    agentkit "github.com/AgoraIO/agora-agents-go/v2/agentkit/cn"
)

client := agentkit.NewAgoraClient(agentkit.ClientOptions{
    AppID:          "your-app-id",
    AppCertificate: "your-app-certificate",
})

ClientOptions

type ClientOptions struct {
    AppID          string
    AppCertificate string
    CustomerID     string
    CustomerSecret string
    Token          string
}

字段	类型	是否必填	说明
`AppID`	`string`	是	声网 App ID
`AppCertificate`	`string`	条件必填	应用凭据鉴权模式下必填；SDK 据此自动生成 ConvoAI REST 鉴权和 RTC 入会 token
`CustomerID`	`string`	否	旧版客户凭据鉴权模式的客户 ID
`CustomerSecret`	`string`	否	旧版客户凭据鉴权模式的客户密钥
`Token`	`string`	否	预先生成的 token

子客户端

client.NewClient 也暴露原始 API 客户端，便于访问尚未被 AgentKit 高层能力封装的接口。大多数场景下，建议优先使用 AgentKit 封装层。

字段	类型	说明
`c.Agents`	`*agents.Client`	智能体生命周期（start、stop、speak、interrupt、update、get、getHistory、getTurns）
`c.AgentManagement`	`*agentmanagement.Client`	管理动作：`agent-think`

所有原始客户端方法都将 context.Context 作为第一个参数。若需要查看完整方法签名，可参考 reference。

环境

根 Agora 包暴露了默认 API 端点：

import Agora "github.com/AgoraIO/agora-agents-go/v2"

Agora.Environments.Default
// "https://api.agora.io/api/conversational-ai-agent"

指针辅助函数

根 Agora 包提供了用于把字面量值转换为指针的辅助函数。许多请求结构使用指针字段来区分“未设置”和“已设置为零值”，因此这些辅助函数在配置可选字段时很有用。

import Agora "github.com/AgoraIO/agora-agents-go/v2"

函数	签名	示例
`Agora.Bool`	`func(bool) *bool`	`Enable: Agora.Bool(true)`
`Agora.Int`	`func(int) *int`	`IdleTimeout: Agora.Int(120)`
`Agora.String`	`func(string) *string`	`APIKey: Agora.String("<key>")`
`Agora.Float64`	`func(float64) *float64`	`Threshold: Agora.Float64(0.5)`
`Agora.Float32`	`func(float32) *float32`	—
`Agora.Int8/16/32/64`	`func(intN) *intN`	—
`Agora.Uint/8/16/32/64`	`func(uintN) *uintN`	—
`Agora.UUID`	`func(uuid.UUID) *uuid.UUID`	—
`Agora.Time`	`func(time.Time) *time.Time`	—

agentkit.NewAgent

Agent 是一个不可变的配置对象。每个服务商链式配置方法都会返回一个新的 *Agent，原对象永远不会被修改。建议在应用启动时定义一个智能体，并在每次用户对话时基于它创建会话。

从 agentkit/cn 导入智能体构建器，从 agentkit/cn/vendors 导入中国区专用服务商；如需自定义 LLM，从 agentkit/vendors 导入通用服务商：

import (
    agentkit "github.com/AgoraIO/agora-agents-go/v2/agentkit/cn"
    commonvendors "github.com/AgoraIO/agora-agents-go/v2/agentkit/vendors"
    vendors "github.com/AgoraIO/agora-agents-go/v2/agentkit/cn/vendors"
)

构造函数

func NewAgent(client *AgoraClient, opts ...AgentOption) *Agent

NewAgent 的第一个参数是已创建的 *AgoraClient，智能体在构造时即与该客户端绑定（因此后续 CreateSession 不再单独传入客户端）。client 为必填项，必须传入非 nil 的 *AgoraClient。

如果传入 nil，NewAgent 会立即 panic，报错为 NewAgent requires AgoraClient。其余传入 AgentOption 函数以配置智能体的名称、instructions、greeting 和其他属性。

agent := agentkit.NewAgent(client,
    agentkit.WithName("support-assistant"),
    agentkit.WithInstructions("You are a helpful voice assistant."), // LLM system prompt
    agentkit.WithGreeting("Hello! How can I help you today?"),       // first words spoken on session start
    agentkit.WithMaxHistory(10),
)

AgentOption 配置函数

AgentOption 函数会作为 NewAgent(client, opts...) 的可变参数传入，在构造与客户端绑定的 Agent 时被应用。其底层签名为 func(*BaseAgent)。

函数	参数类型	说明
`WithName(name)`	`string`	智能体名称标识符
`WithInstructions(instructions)`	`string`	LLM 系统提示词
`WithGreeting(greeting)`	`string`	智能体播报的首条消息
`WithFailureMessage(msg)`	`string`	LLM 失败时播报的消息
`WithMaxHistory(n)`	`int`	保留的最大对话轮次数
`WithTurnDetectionConfig(td)`	`*TurnDetectionConfig`	级联流程的 turn detection 配置。使用 `Config.StartOfSpeech` 和 `Config.EndOfSpeech` 配置 SOS/EOS 检测；打断行为使用 interruption 配置
`WithInterruptionConfig(interruption)`	`*InterruptionConfig`	使用顶层 `interruption` 对象进行统一打断控制
`WithGreetingConfigs(configs)`	`*LlmGreetingConfigs`	设置 `llm.greeting_configs`，包括 v2.7 的 `interruptable`
`WithSalConfig(sal)`	`*SalConfig`	语音分析配置
`WithAdvancedFeatures(af)`	`*AdvancedFeatures`	高级特性开关，例如 `EnableAivad`
`WithTools(enabled)`	`bool`	启用或关闭 MCP 和自定义工具调用
`WithParameters(params)`	`*SessionParams`	附加会话参数
`WithAudioScenario(audioScenario)`	`ParametersAudioScenario`	设置 `parameters.audio_scenario`（`default`、`chorus` 或 `aiserver`）。未设置时，SDK 会自动补成 `chorus`
`WithGeofence(gf)`	`*GeofenceConfig`	区域访问限制
`WithLabels(labels)`	`map[string]string`	在通知回调中返回的自定义键值标签
`WithRtc(rtc)`	`*RtcConfig`	RTC 媒体加密配置
`WithFillerWords(fw)`	`*FillerWordsConfig`	在等待 LLM 响应期间播放的承接词

服务商链式配置方法

Vendor 方法调用在 NewAgent 返回的 *Agent 上。每个方法都会返回一个新的 *Agent，原对象永远不会被修改。

中国区专用服务商从 agentkit/cn/vendors 取用；可在 CN 场景复用的 common/custom 服务商从 agentkit/vendors 取用。

`WithLlm(vendor)`

设置 LLM 服务商。传入 NewAliyun、NewBytedance、NewDeepSeek、NewTencentLLM 或 NewCustomLLM 的实例。

func (a *Agent) WithLlm(vendor vendors.LLM) *Agent

`WithTts(vendor)`

设置 TTS 服务商。会记录该服务商的采样率，以便进行数字人校验。

func (a *Agent) WithTts(vendor vendors.TTS) *Agent

`WithStt(vendor)`

设置 STT 服务商。传入任意 STT 服务商 constructor 的实例。

func (a *Agent) WithStt(vendor vendors.STT) *Agent

`WithAvatar(vendor)`

设置数字人服务商。当前提供 NewSensetimeAvatar 和 NewSpatiusAvatar。如果已经配置了 TTS，且其采样率与数字人所需采样率不一致，则会 panic。

func (a *Agent) WithAvatar(vendor vendors.Avatar) *Agent

`WithTurnDetection(config)`

配置级联流程的 turn detection。使用 Config.StartOfSpeech 和 Config.EndOfSpeech 配置 SOS/EOS 检测；打断行为使用 interruption 配置。

func (a *Agent) WithTurnDetection(td *TurnDetectionConfig) *Agent

其他构建方法

以下方法遵循相同模式，都会返回一个包含更新后配置的新 *Agent。

方法	参数类型	说明
`WithInstructions(instructions)`	`string`	覆盖 LLM 系统提示词
`WithGreeting(greeting)`	`string`	覆盖问候语
`WithName(name)`	`string`	覆盖智能体名称
`WithSal(sal)`	`*SalConfig`	设置 SAL 配置
`WithAdvancedFeatures(af)`	`*AdvancedFeatures`	设置高级特性
`WithTools(enabled)`	`bool`	启用或关闭 MCP 和自定义工具调用
`WithParameters(params)`	`*SessionParams`	设置会话参数
`WithFailureMessage(msg)`	`string`	设置失败提示消息
`WithMaxHistory(n)`	`int`	设置最大对话历史长度
`WithGeofence(gf)`	`*GeofenceConfig`	设置 geofence 配置
`WithLabels(labels)`	`map[string]string`	设置自定义标签
`WithRtc(rtc)`	`*RtcConfig`	设置 RTC 配置
`WithFillerWords(fw)`	`*FillerWordsConfig`	设置承接词配置

将智能体配置转换为 *Agora.StartAgentsRequestProperties，供 Start Agent API 使用。AgentSession.Start() 内部会调用该方法。只有在你需要自行构造请求体时，才需要直接使用它。如果未显式设置 WithAudioScenario(...)，生成的 properties.parameters.audio_scenario 会自动补为 chorus。

func (a *Agent) ToProperties(opts ToPropertiesOptions) (*Agora.StartAgentsRequestProperties, error)

在以下情况下会返回 error：

未提供 Token，且也未提供 AppID + AppCertificate
在级联模式下：未配置 LLM 或 TTS
配置序列化失败

ToPropertiesOptions

type ToPropertiesOptions struct {
    Channel         string
    AgentUID        string
    RemoteUIDs      []string
    Token           string
    AppID           string
    AppCertificate  string
    ExpiresIn       int
    IdleTimeout     *int
    EnableStringUID *bool
    SkipVendorValidation bool
    Warn            func(string)
}

字段	类型	是否必填	说明
`Channel`	`string`	是	声网频道名
`AgentUID`	`string`	是	智能体在频道中的 UID
`RemoteUIDs`	`[]string`	是	远端参与者 UID 列表
`Token`	`string`	条件必填	预先生成的 RTC+RTM token。设置后会跳过自动生成
`AppID`	`string`	条件必填	声网 App ID。未设置 `Token` 时必填
`AppCertificate`	`string`	条件必填	声网 App 证书。未设置 `Token` 时必填
`ExpiresIn`	`int`	否	token 有效期，单位为秒。默认值：`86400`。有效范围：1–86400
`IdleTimeout`	`*int`	否	会话空闲超时时间，单位为秒
`EnableStringUID`	`*bool`	否	启用字符串 UID 模式
`SkipVendorValidation`	`bool`	否	用于基于 pipeline 启动且未显式配置 LLM/TTS 的高级选项
`Warn`	`func(string)`	否	用于接收可恢复配置问题的告警回调

属性获取方法

任意 *Agent 实例都提供以下只读方法。

方法	返回类型	说明
`Name()`	`string`	智能体名称
`Instructions()`	`string`	LLM 系统提示词
`Greeting()`	`string`	问候语
`FailureMessage()`	`string`	LLM 失败时播报的消息
`MaxHistory()`	`*int`	最大对话历史长度
`LlmConfig()`	`map[string]interface{}`	LLM 配置
`TtsConfig()`	`map[string]interface{}`	TTS 配置
`SttConfig()`	`map[string]interface{}`	STT 配置
`MllmConfig()`	`map[string]interface{}`	MLLM 配置
`TtsSampleRate()`	`*vendors.SampleRate`	TTS 采样率
`AvatarRequiredSampleRate()`	`*vendors.SampleRate`	数字人所需采样率
`Avatar()`	`map[string]interface{}`	Avatar 配置
`TurnDetection()`	`*TurnDetectionConfig`	Turn detection 配置
`Interruption()`	`*InterruptionConfig`	打断配置
`GreetingConfigs()`	`*LlmGreetingConfigs`	问候语播放配置
`Sal()`	`*SalConfig`	SAL 配置
`AdvancedFeatures()`	`*AdvancedFeatures`	高级特性
`Parameters()`	`*SessionParams`	会话参数
`Geofence()`	`*GeofenceConfig`	Geofence 配置
`Labels()`	`map[string]string`	自定义标签
`Rtc()`	`*RtcConfig`	RTC 配置
`FillerWords()`	`*FillerWordsConfig`	承接词配置

agentkit.NewAgentSession

AgentSession 管理运行中智能体的完整生命周期。常规用法是在智能体上调用 CreateSession，然后调用 Start() 让智能体加入频道。NewAgentSession 是底层构造函数，仅在你需要自行装配会话选项时使用。

import (
    agentkit "github.com/AgoraIO/agora-agents-go/v2/agentkit/cn"
)

`CreateSession`（推荐）

由于智能体在 NewAgent(client, ...) 时已与客户端绑定，CreateSession 不再需要单独传入客户端：

func (a *Agent) CreateSession(opts CreateSessionOptions) *AgentSession

session := agent.CreateSession(agentkit.CreateSessionOptions{
    Channel:    "cn-room",
    AgentUID:   "1001",
    RemoteUIDs: []string{"1002"},
})

agentID, err := session.Start(context.Background())

构造函数

func NewAgentSession(opts AgentSessionOptions) *AgentSession

如果 Name 为空，默认值为 agent-<unix_timestamp>。会话初始状态为 StatusIdle。

AgentSessionOptions

type AgentSessionOptions struct {
    Client          *agents.Client
    Agent           AgentRuntime
    AppID           string
    AppCertificate  string
    Name            string
    Channel         string
    Token           string
    AgentUID        string
    RemoteUIDs      []string
    IdleTimeout     *int
    EnableStringUID *bool
    ExpiresIn       int
    UseAppCredentialsForREST bool
    PipelineID      string
    Debug           bool
    Warn            func(string)
}

字段	类型	是否必填	说明
`Client`	`*agents.Client`	是	原始 agents 客户端（来自 `c.Agents`）
`Agent`	`AgentRuntime`	是	智能体运行时配置抽象，由 `agentkit/cn` 封装接口通过 `NewAgent` 构建
`AppID`	`string`	是	声网 App ID
`AppCertificate`	`string`	条件必填	未设置 `Token` 时必填
`Name`	`string`	否	会话名称。默认值：`agent-<unix_timestamp>`
`Channel`	`string`	是	声网频道名
`Token`	`string`	条件必填	预先生成的 RTC+RTM token。设置后会跳过自动生成
`AgentUID`	`string`	是	智能体在频道中的 UID
`RemoteUIDs`	`[]string`	是	远端参与者 UID 列表
`IdleTimeout`	`*int`	否	空闲超时时间，单位为秒
`EnableStringUID`	`*bool`	否	启用字符串 UID 模式
`ExpiresIn`	`int`	否	自动生成 token 的有效期，单位为秒
`UseAppCredentialsForREST`	`bool`	否	按请求生成 ConvoAI REST 鉴权 Header
`PipelineID`	`string`	否	会话启动时发送的已发布工作流 ID
`Debug`	`bool`	否	启用启动请求的调试日志输出
`Warn`	`func(string)`	否	自定义告警回调；默认使用 logger

PipelineID 会作为顶层 /join 字段 pipeline_id 发送，而不是放在 properties 内。如果未设置，AgentSession.Start() 会使用 WithPipelineID 在智能体级别设置的值。

状态机

会话会按以下状态流转：

Text

         Start()           API success
  ┌──────┐      ┌──────────┐      ┌─────────┐
  │ idle │─────>│ starting │─────>│ running │
  └──┬───┘      └────┬─────┘      └────┬────┘
     │               │                  │
     │               │ error            │ Stop()
     │               ▼                  ▼
     │          ┌─────────┐      ┌──────────┐
     │          │  error  │      │ stopping │
     │          └────┬────┘      └────┬─────┘
     │               │                │
     │               │                │ success
     │               ▼                ▼
     │          ┌──────────┐     ┌─────────┐
     └─────────>│ (restart)│     │ stopped │
                └──────────┘     └─────────┘

状态变化	触发条件
`idle → starting`	调用 `Start()`
`starting → running`	API 返回智能体 ID
`starting → error`	API 请求失败
`running → stopping`	调用 `Stop()`
`stopping → stopped`	API 确认智能体已停止
`stopping → error`	停止请求失败，且智能体并未提前停止
`running → error`	交互过程中发生不可恢复错误

在 stopped 或 error 状态下，也可以再次调用 Start() 来重启会话。

方法

所有方法都将 context.Context 作为第一个参数。请在调用 Start() 之前注册事件处理函数，以免错过 started 事件。

`Start(ctx)`

启动智能体会话。若未提供 token，会自动生成 token，然后调用 Agora API，并返回智能体 ID。

func (s *AgentSession) Start(ctx context.Context) (string, error)

可用状态：idle、stopped、error
状态流转：成功时 starting → running，失败时进入 error
触发事件：成功时 "started"，失败时 "error"
发起 API 调用前，会校验数字人配置以及数字人/TTS 采样率是否匹配
会校验服务商是否与 agentkit/cn 封装接口匹配：只接受中国区专用服务商且不支持 MLLM；不匹配时返回 error
CN 场景下各服务商均为 BYOK；请始终显式提供对应服务商的凭据
先取会话级 PipelineID，其次取智能体级值，并作为顶层 /join.pipeline_id 发送

agentID, err := session.Start(ctx)
if err != nil {
    log.Fatalf("Failed to start session: %v", err)
}

`Stop(ctx)`

停止正在运行的智能体，并将其移出频道。

func (s *AgentSession) Stop(ctx context.Context) error

可用状态：running
状态流转：成功时 stopping → stopped，失败时进入 error
触发事件：成功时 "stopped"，失败时 "error"

err := session.Stop(ctx)
if err != nil {
    log.Fatalf("Failed to stop session: %v", err)
}

`Say(ctx, text, priority, interruptable)`

指示智能体播报给定文本。

func (s *AgentSession) Say(ctx context.Context, text string, priority *Agora.SpeakAgentsRequestPriority, interruptable *bool) error

可用状态：running
若要使用默认值，可将 priority 或 interruptable 传 nil

参数	类型	说明
`text`	`string`	要让智能体播报的文本
`priority`	`*Agora.SpeakAgentsRequestPriority`	可选优先级。传 `nil` 使用默认值。建议使用 `agentkit.SpeakPriorityInterrupt.Ptr()`、`agentkit.SpeakPriorityAppend.Ptr()` 或 `agentkit.SpeakPriorityIgnore.Ptr()` 这些便捷常量，而不是直接使用原始生成枚举
`interruptable`	`*bool`	该消息是否允许被打断。传 `nil` 使用默认值

err := session.Say(ctx, "One moment while I look that up.", nil, nil)

`Interrupt(ctx)`

打断智能体当前正在播报的内容。

func (s *AgentSession) Interrupt(ctx context.Context) error

可用状态：running

`Update(ctx, properties)`

在不重启会话的情况下更新智能体属性。该方法接收 REST API 格式的强类型 properties 结构。

func (s *AgentSession) Update(ctx context.Context, properties *Agora.UpdateAgentsRequestProperties) error

可用状态：running

`GetHistory(ctx)`

获取对话历史。要求存在有效的智能体 ID，也就是必须先成功调用过 Start()。

func (s *AgentSession) GetHistory(ctx context.Context) (*Agora.GetHistoryAgentsResponse, error)

`GetTurns(ctx)` / `GetAllTurns(ctx)`

获取该会话的逐轮分析数据。要求存在有效的智能体 ID，也就是必须先成功调用过 Start()。

func (s *AgentSession) GetTurns(ctx context.Context, opts ...GetTurnsOptions) (*Agora.GetTurnsAgentsResponse, error)
func (s *AgentSession) GetAllTurns(ctx context.Context, opts ...GetAllTurnsOptions) (*Agora.GetTurnsAgentsResponse, error)

type GetTurnsOptions struct {
    PageIndex *int
    PageSize  *int
}

type GetAllTurnsOptions struct {
    PageSize *int
}

PageIndex 从 1 开始。GetAllTurns 会按默认每页 50 条自动遍历所有分页，并返回聚合后的最终 Turns 结果。

前提条件： 有效的智能体 ID

当你消费服务端通知时，事件 112 表示该会话的所有 turns 都已结束并可查询。

`GetInfo(ctx)`

从 API 获取当前智能体状态。要求存在有效的智能体 ID。

func (s *AgentSession) GetInfo(ctx context.Context) (*Agora.GetAgentsResponse, error)

`Think(ctx)`

向运行中的智能体注入一条 thought 或 instruction。在 v2.7 中，如果省略 on_listening_action，服务端默认值为 interrupt。如果你需要旧版的 inject 行为，请设置 agentkit.ThinkOnListeningActionInject.Ptr()。

三个状态均支持 append：ThinkOnListeningActionAppend、ThinkOnThinkingActionAppend 和 ThinkOnSpeakingActionAppend。该值不打断当前交互，分别等待当前用户回合、LLM 推理或 TTS 播报完成后，再将该指令作为独立的 user 消息追加到上下文并发起新一轮对话。对应状态还提供 Interrupt 和 Ignore 常量，倾听状态额外提供 ThinkOnListeningActionInject。

func (s *AgentSession) Think(ctx context.Context, text string, onListeningAction *Agora.AgentThinkAgentManagementRequestOnListeningAction, onThinkingAction *Agora.AgentThinkAgentManagementRequestOnThinkingAction, onSpeakingAction *Agora.AgentThinkAgentManagementRequestOnSpeakingAction, interruptable *bool, metadata map[string]string) (*Agora.AgentThinkAgentManagementResponse, error)
func (s *AgentSession) ThinkWithOptions(ctx context.Context, text string, opts *ThinkOptions) (*Agora.AgentThinkAgentManagementResponse, error)

适用状态： running

`On(event, handler)`

注册事件处理函数。同一事件可以注册多个 handler。handler 会同步执行；如果 handler 发生 panic，会话会捕获该 panic，并通过会话的 warning sink 进行上报。

func (s *AgentSession) On(event string, handler EventHandler)

session.On("started", func(data interface{}) {
    info := data.(map[string]string)
    fmt.Println("Agent is live:", info["agent_id"])
})
session.On("stopped", func(data interface{}) {
    fmt.Println("Agent has left")
})
session.On("error", func(data interface{}) {
    log.Println("Session error:", data)
})

`Off(event, handler)`

取消注册之前已注册的事件处理函数。

func (s *AgentSession) Off(event string, handler EventHandler)

事件

事件	数据类型	说明
`"started"`	`map[string]string{"agent_id": "..."}`	智能体已成功加入频道
`"stopped"`	`map[string]string{"agent_id": "..."}`	智能体已离开频道
`"error"`	`error`	发生了不可恢复错误

属性获取方法

任意 *AgentSession 实例都提供以下只读方法。

方法	返回类型	说明
`ID()`	`string`	智能体 ID。在 `Start()` 成功前为空字符串
`Status()`	`SessionStatus`	当前会话状态
`Agent()`	`AgentRuntime`	当前智能体的运行时配置抽象（`AgentRuntime` 接口，由 `agentkit/cn` 封装接口通过 `NewAgent` 构建）
`AppID()`	`string`	声网 App ID
`Raw()`	`*agents.Client`	直接访问原始 agents 客户端，适用于高级操作场景

使用 `session.Raw()`

你可以通过 session.Raw() 调用 AgentKit 封装层尚未封装的 REST API 端点。

response, err := session.Raw().List(ctx, &Agora.ListAgentsRequest{
    Appid: session.AppID(),
})

线程安全

所有状态访问都由 sync.RWMutex 保护。该会话可安全地在多个 goroutine 中并发使用。

服务商

中国区专用服务商 constructor 位于 github.com/AgoraIO/agora-agents-go/v2/agentkit/cn/vendors；可在 CN 场景复用的 common/custom 服务商 constructor 位于 github.com/AgoraIO/agora-agents-go/v2/agentkit/vendors。这些服务商配合 agentkit/cn 的 WithStt()、WithLlm()、WithTts()、WithAvatar() 链式方法使用。

import (
    agentkit "github.com/AgoraIO/agora-agents-go/v2/agentkit/cn"
    commonvendors "github.com/AgoraIO/agora-agents-go/v2/agentkit/vendors"
    vendors "github.com/AgoraIO/agora-agents-go/v2/agentkit/cn/vendors"
)

接口

服务商包提供 LLM、TTS、STT、Avatar 四个接口。

type LLM interface {
    ToConfig() map[string]interface{}
}

type TTS interface {
    ToConfig() map[string]interface{}
    GetSampleRate() *SampleRate
}

type STT interface {
    ToConfig() map[string]interface{}
}

type Avatar interface {
    ToConfig() map[string]interface{}
    RequiredSampleRate() SampleRate
}

LLM 服务商

LLM 服务商全部基于 OpenAI 兼容协议（style = "openai"），共享同一套 OpenAIOptions，区别仅在于内部写入的 vendor 标识。这些 constructor 都要求 APIKey、Model 和 BaseURL，否则 panic。

构造函数	`vendor` 值	说明
`NewAliyun(opts)`	`aliyun`	阿里云百炼（通义千问，如 `qwen-max`）
`NewBytedance(opts)`	`bytedance`	字节跳动火山引擎（豆包，如 `doubao-seed-1-6`）
`NewDeepSeek(opts)`	`deepseek`	DeepSeek（如 `deepseek-chat`）
`NewTencentLLM(opts)`	`tencent`	腾讯混元（如 `hunyuan-turbos-latest`）
`commonvendors.NewCustomLLM(opts)`	`custom`	任意 OpenAI 兼容协议的 LLM

func NewAliyun(opts AliyunOptions) *Aliyun
func NewBytedance(opts BytedanceOptions) *Bytedance
func NewDeepSeek(opts DeepSeekOptions) *DeepSeek
func NewTencentLLM(opts TencentLLMOptions) *TencentLLM
func NewCustomLLM(opts CustomLLMOptions) *CustomLLM

AliyunOptions、BytedanceOptions、DeepSeekOptions、TencentLLMOptions、commonvendors.CustomLLMOptions 均使用 OpenAIOptions 字段：

字段	类型	是否必填	说明
`APIKey`	`string`	是	服务商 API 密钥
`Model`	`string`	是	模型标识符
`BaseURL`	`string`	是	OpenAI 兼容的 `chat/completions` 端点
`Temperature`	`*float64`	否	采样温度，写入 `params.temperature`
`TopP`	`*float64`	否	核采样，写入 `params.top_p`
`MaxTokens`	`*int`	否	最大 token 数，写入 `params.max_tokens`
`MaxHistory`	`*int`	否	最大历史轮数
`SystemMessages`	`[]map[string]interface{}`	否	系统消息
`GreetingMessage`	`string`	否	智能体问候语
`FailureMessage`	`string`	否	LLM 失败时播报的消息
`InputModalities`	`[]string`	否	输入模态，默认 `["text"]`
`OutputModalities`	`[]string`	否	输出模态
`Params`	`map[string]interface{}`	否	附加模型参数，合并进 `params`
`Headers`	`map[string]string`	否	透传给服务商的自定义 HTTP 请求头
`GreetingConfigs`	`map[string]interface{}`	否	问候语播放配置
`TemplateVariables`	`map[string]string`	否	消息模板变量
`McpServers`	`[]map[string]interface{}`	否	MCP 服务器配置；缺省的 `transport` 会自动补为 `streamable_http`
`Tools`	`[]*Agora.LlmTool`	否	同步自定义工具定义；需要同时启用 `WithTools(true)`
`Vendor`	`string`	否	覆盖默认服务商标识（通常无需设置）

Tools 用于声明供 LLM 选择调用的自定义工具。每个工具包含模型可见的函数定义，以及同步 GET 或 POST 请求的服务端配置；WithTools(true) 同时适用于 Tools 和 McpServers。

语音识别服务商

`NewFengmingSTT`

func NewFengmingSTT(options ...FengmingSTTOptions) *FengmingSTT

声网自研的「风鸣」STT 服务，无需外部凭据，输出 asr.vendor = "fengming"。options 可省略以保持 NewFengmingSTT() 兼容；传入多个 options 值会 panic。

字段	类型	是否必填	说明
`Keywords`	`[]string`	否	热词列表，用于提升 ASR 识别准确率
`AdditionalParams`	`map[string]interface{}`	否	附加 Fengming 参数，合并进 `asr.params`

`NewTencentSTT`

func NewTencentSTT(opts TencentSTTOptions) *TencentSTT

如果 Key、AppID 或 Secret 为空，会 panic。

字段	类型	是否必填	说明
`Key`	`string`	是	腾讯云 ASR 参数 `secret_id`
`AppID`	`string`	是	腾讯云 App ID
`Secret`	`string`	是	腾讯云 ASR 参数 `secret_key`
`EngineModelType`	`string`	否	引擎模型类型
`VoiceID`	`string`	否	会话标识
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数，合并进 `params`

`NewMicrosoftSTT`

func NewMicrosoftSTT(opts MicrosoftSTTOptions) *MicrosoftSTT

如果 Key、Region 或 Language 为空，会 panic。

字段	类型	是否必填	说明
`Key`	`string`	是	Azure 语音服务密钥
`Region`	`string`	是	Azure 区域
`Language`	`string`	是	语言代码，例如 `"zh-CN"`
`PhraseList`	`[]string`	否	提升识别准确率的短语列表
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数，合并进 `params`

语音合成服务商

所有 CN TTS 服务商都支持 AdditionalParams（合并进 params）和 SkipPatterns（跳过的文本模式）。

`NewMiniMaxTTS`

func NewMiniMaxTTS(opts MiniMaxTTSOptions) *MiniMaxTTS

MiniMax TTS 要求 Key 和 Model。此外必须提供 VoiceSetting.VoiceID 或非空的 TimberWeights 之一，否则 panic。

字段	类型	是否必填	说明
`Key`	`string`	是	MiniMax API 密钥
`Model`	`string`	是	模型名
`VoiceSetting`	`*MiniMaxVoiceSetting`	条件必填	音色设置；未提供 `TimberWeights` 时必须设置且 `VoiceID` 非空
`TimberWeights`	`[]MiniMaxTimberWeight`	条件必填	混合音色权重；未提供 `VoiceSetting.VoiceID` 时必填
`AudioSetting`	`*MiniMaxAudioSetting`	否	音频设置（`SampleRate`）
`PronunciationDict`	`*MiniMaxPronunciationDict`	否	发音词典（`Tone []string`）
`LanguageBoost`	`string`	否	语言增强
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数
`SkipPatterns`	`[]int`	否	要跳过的模式

MiniMaxVoiceSetting 字段：VoiceID string、Speed *int、Volume *int（输出为 vol）、Pitch *int、Emotion string、LatexRead *bool、EnglishNormalization *bool。MiniMaxTimberWeight 字段：VoiceID string、Weight int。

`NewTencentTTS`

func NewTencentTTS(opts TencentTTSOptions) *TencentTTS

如果 AppID、SecretID 或 SecretKey 为空，会 panic。

字段	类型	是否必填	说明
`AppID`	`string`	是	腾讯云 App ID
`SecretID`	`string`	是	腾讯云 Secret ID
`SecretKey`	`string`	是	腾讯云 Secret Key
`VoiceType`	`*int`	否	音色类型
`Volume`	`*float64`	否	音量
`Speed`	`*float64`	否	语速
`EmotionCategory`	`string`	否	情感类别
`EmotionIntensity`	`*int`	否	情感强度
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数
`SkipPatterns`	`[]int`	否	要跳过的模式

`NewMicrosoftTTS`

func NewMicrosoftTTS(opts MicrosoftTTSOptions) *MicrosoftTTS

如果 Key、Region 或 VoiceName 为空，会 panic。GetSampleRate() 返回 SampleRate 字段值（可参与数字人采样率校验）。

字段	类型	是否必填	说明
`Key`	`string`	是	Azure 语音服务密钥
`Region`	`string`	是	Azure 区域
`VoiceName`	`string`	是	音色名
`SampleRate`	`*SampleRate`	否	音频采样率
`Speed`	`*float64`	否	语速
`Volume`	`*float64`	否	音量
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数
`SkipPatterns`	`[]int`	否	要跳过的模式

`NewGenericTTS`

func NewGenericTTS(opts GenericTTSOptions) *GenericTTS

自定义 OpenAI 兼容 HTTP TTS。URL 必填，且必须是包含 host 的 HTTP 或 HTTPS 绝对地址；缺失 URL 时会 panic，地址格式错误或使用 ws、wss、ftp 等协议时也会 panic。合法地址会序列化为 tts.vendor = "generic_http"。

字段	类型	是否必填	说明
`URL`	`string`	是	自定义 TTS 服务的 HTTP(S) endpoint
`Headers`	`map[string]string`	否	转发给 TTS 服务的自定义 HTTP 请求头；未设置时不会写入 `headers`
`APIKey`	`string`	否	TTS 服务鉴权 API 密钥
`Model`	`string`	否	TTS 模型名
`Voice`	`string`	否	音色名
`Speed`	`*float64`	否	语速
`SampleRate`	`*SampleRate`	否	输出音频采样率，单位为 Hz。如果你的 TTS 服务暂不支持多采样率，请确保返回音频的采样率与该配置一致。
`ResponseFormat`	`string`	否	输出音频格式，当前 ConvoAI 支持 `pcm`
`Instruction`	`string`	否	语音风格、情绪或其他播报指令。
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数；同名字段会被非空的显式字段覆盖
`SkipPatterns`	`[]int`	否	控制 TTS 跳过特定文本模式

`NewBytedanceTTS`

func NewBytedanceTTS(opts BytedanceTTSOptions) *BytedanceTTS

如果 Token、AppID、Cluster 或 VoiceType 为空，会 panic。

字段	类型	是否必填	说明
`Token`	`string`	是	字节跳动访问 token
`AppID`	`string`	是	声网 App ID
`Cluster`	`string`	是	集群标识
`VoiceType`	`string`	是	音色类型
`SpeedRatio`	`*float64`	否	语速比例
`VolumeRatio`	`*float64`	否	音量比例
`PitchRatio`	`*float64`	否	音调比例
`Emotion`	`string`	否	情感
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数
`SkipPatterns`	`[]int`	否	要跳过的模式

`NewCosyVoiceTTS`

func NewCosyVoiceTTS(opts CosyVoiceTTSOptions) *CosyVoiceTTS

阿里云 CosyVoice TTS。如果 APIKey、Model 或 Voice 为空，会 panic。GetSampleRate() 返回 SampleRate 字段值。

字段	类型	是否必填	说明
`APIKey`	`string`	是	阿里云 API 密钥
`Model`	`string`	是	模型名
`Voice`	`string`	是	音色
`SampleRate`	`*int`	否	音频采样率
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数
`SkipPatterns`	`[]int`	否	要跳过的模式

`NewBytedanceDuplexTTS`

func NewBytedanceDuplexTTS(opts BytedanceDuplexTTSOptions) *BytedanceDuplexTTS

字节跳动全双工 TTS（vendor = "bytedance_duplex"）。如果 AppID、Token 或 Speaker 为空，会 panic。

字段	类型	是否必填	说明
`AppID`	`string`	是	声网 App ID
`Token`	`string`	是	访问 token
`Speaker`	`string`	是	发音人
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数
`SkipPatterns`	`[]int`	否	要跳过的模式

`NewStepFunTTS`

func NewStepFunTTS(opts StepFunTTSOptions) *StepFunTTS

阶跃星辰 StepFun TTS。如果 APIKey、Model 或 VoiceID 为空，会 panic。

字段	类型	是否必填	说明
`APIKey`	`string`	是	StepFun API 密钥
`Model`	`string`	是	模型名
`VoiceID`	`string`	是	音色 ID
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数
`SkipPatterns`	`[]int`	否	要跳过的模式

数字人服务商

`NewSensetimeAvatar`

func NewSensetimeAvatar(opts SensetimeAvatarOptions) *SensetimeAvatar

商汤数字人。如果 AgoraUID、AppID、AppKey 为空，或 SceneList 为空，会 panic。RequiredSampleRate() 返回 0，即不强制固定 TTS 采样率。

字段	类型	是否必填	说明
`AgoraUID`	`string`	是	Avatar 视频流对应的 UID
`AppID`	`string`	是	商汤 App ID（输出为 `appId`）
`AppKey`	`string`	是	商汤 App Key
`SceneList`	`[]SensetimeScene`	是	场景列表，至少一项
`AgoraToken`	`string`	否	Avatar 鉴权 RTC token
`Enable`	`*bool`	否	启用或关闭数字人，默认 `true`
`AdditionalParams`	`map[string]interface{}`	否	附加服务商参数，合并进 `params`

场景类型结构：

type SensetimeScene struct {
    DigitalRole SensetimeDigitalRole
}

type SensetimeDigitalRole struct {
    FaceFeatureID string            // 输出为 face_feature_id
    Position      SensetimePosition // 输出为 position.x / position.y
    URL           string            // 输出为 url
}

type SensetimePosition struct {
    X int
    Y int
}

`NewSpatiusAvatar`

func NewSpatiusAvatar(opts SpatiusAvatarOptions) *SpatiusAvatar

Spatius 数字人。如果 SpatiusAPIKey、SpatiusAppID、SpatiusAvatarID 或 AgoraUID 为空，会 panic。RequiredSampleRate() 返回 SampleRate 字段值；如果未设置则返回 0，即不强制固定 TTS 采样率。

字段	类型	是否必填	说明
`SpatiusAPIKey`	`string`	是	Spatius API 密钥
`SpatiusAppID`	`string`	是	Spatius 应用 ID
`SpatiusAvatarID`	`string`	是	Spatius 数字人 ID
`AgoraUID`	`string`	是	Avatar 视频流对应的 UID
`Region`	`string`	否	Spatius 服务区域
`AgoraToken`	`string`	否	Avatar 鉴权 RTC token
`SampleRate`	`*SampleRate`	否	数字人所需 TTS 音频采样率，单位 Hz
`SessionExpireMinutes`	`*int`	否	Spatius 会话过期时间，单位分钟
`Enable`	`*bool`	否	启用或关闭数字人，默认 `true`
`AdditionalParams`	`map[string]interface{}`	否	附加 Spatius 数字人参数，合并进 `params`

Token 工具

用于生成和管理 token 的辅助函数。

import "github.com/AgoraIO/agent-server-sdk-go/agentkit"

func GenerateRtcToken(opts GenerateTokenOptions) (string, error)
func GenerateRtcTokenWithAccount(opts GenerateRtcTokenWithAccountOptions) (string, error)
func GenerateConvoAIToken(opts GenerateConvoAITokenOptions) (string, error)

`GenerateConvoAIToken()`

生成一个组合型 RTC+RTM Conversational AI token。这与在 AgentSessionOptions 中提供 AppID 和 AppCertificate 时，SDK 自动生成的 token 相同。

func GenerateConvoAIToken(opts GenerateConvoAITokenOptions) (string, error)

字段	类型	是否必填	说明
`AppID`	`string`	是	声网 App ID
`AppCertificate`	`string`	是	声网 App 证书
`ChannelName`	`string`	是	该 token 被授予访问权限的频道
`Account`	`string`	是	该 token 对应的 UID（字符串形式）
`TokenExpire`	`int`	否	token 有效期，单位为秒。默认值：`86400`。有效范围：1–86400

token, err := agentkit.GenerateConvoAIToken(agentkit.GenerateConvoAITokenOptions{
    AppID:          os.Getenv("AGORA_APP_ID"),
    AppCertificate: os.Getenv("AGORA_APP_CERT"),
    ChannelName:    "support-room-123",
    Account:        "1",
    TokenExpire:    agentkit.ExpiresInHours(12),
})

`GenerateRtcTokenWithAccount()`

为字符串账号（user ID）生成 RTC token。对于大多数 Conversational AI 场景，建议改用 GenerateConvoAIToken()。

func GenerateRtcTokenWithAccount(opts GenerateRtcTokenWithAccountOptions) (string, error)

字段	类型	是否必填	说明
`AppID`	`string`	是	声网 App ID
`AppCertificate`	`string`	是	声网 App 证书
`Channel`	`string`	是	频道名
`Account`	`string`	是	字符串用户账号
`Role`	`int`	否	RTC 角色：`RolePublisher` (1) 或 `RoleSubscriber` (2)。默认值：`RolePublisher`
`ExpirySeconds`	`int`	否	token 有效期，单位为秒。默认值：`DefaultExpirySeconds` (86400)

`GenerateRtcToken()`

生成仅用于 RTC 的 token。对于大多数 Conversational AI 场景，建议改用 GenerateConvoAIToken()。

func GenerateRtcToken(opts GenerateTokenOptions) (string, error)

字段	类型	是否必填	说明
`AppID`	`string`	是	声网 App ID
`AppCertificate`	`string`	是	声网 App 证书
`Channel`	`string`	是	频道名
`UID`	`uint32`	是	用户 ID。传 `0` 表示任意用户
`Role`	`int`	否	RTC 角色：`RolePublisher` (1) 或 `RoleSubscriber` (2)。默认值：`RolePublisher`
`ExpirySeconds`	`int`	否	token 有效期，单位为秒。默认值：`DefaultExpirySeconds` (3600)

`ExpiresInHours()` / `ExpiresInMinutes()`

用于指定 token 有效期的辅助函数。可与 AgentSessionOptions.ExpiresIn 或 token 生成函数配合使用。如果值小于等于 0，会返回 error；如果结果超过 24 小时，则会给出 warning 并截断为 86400。

func ExpiresInHours(hours int) (int, error)
func ExpiresInMinutes(minutes int) (int, error)

expiresIn, err := agentkit.ExpiresInHours(12)
if err != nil {
    log.Fatalf("Invalid expiry: %v", err)
}

session := agentkit.NewAgentSession(agentkit.AgentSessionOptions{
    // ...
    ExpiresIn: expiresIn,
})

类型与常量

SDK 中共享的类型、常量和枚举。

`SessionStatus`

表示会话生命周期状态的强类型字符串常量。可通过 session.Status() 读取。

type SessionStatus string

const (
    StatusIdle     SessionStatus = "idle"
    StatusStarting SessionStatus = "starting"
    StatusRunning  SessionStatus = "running"
    StatusStopping SessionStatus = "stopping"
    StatusStopped  SessionStatus = "stopped"
    StatusError    SessionStatus = "error"
)

`SampleRate`

表示音频采样率的强类型整型常量。可用于 TTS 服务商的 SampleRate 字段和数字人采样率校验。

type SampleRate int

const (
    SampleRate8kHz  SampleRate = 8000
    SampleRate16kHz SampleRate = 16000
    SampleRate22kHz SampleRate = 22050
    SampleRate24kHz SampleRate = 24000
    SampleRate44kHz SampleRate = 44100
    SampleRate48kHz SampleRate = 48000
)

用于数字人采样率要求的便捷常量：

const (
    LiveAvatarRequiredSampleRate = SampleRate24kHz
    AkoolRequiredSampleRate  = SampleRate16kHz  // 16000 Hz
)

`EventHandler`

会话事件处理函数的签名。将你的实现传给 session.On()。

type EventHandler func(data interface{})

事件	`data` type	类型转换示例
`"started"`	`map[string]string`	`data.(map[string]string)["agent_id"]`
`"stopped"`	`map[string]string`	`data.(map[string]string)["agent_id"]`
`"error"`	`error`	`data.(error)`

区域常量

固定使用 option.AreaCN。agentkit/cn.NewAgoraClient 内部已设置好该区域，无需手动指定。

option.AreaCN // Chinese Mainland (east + north)

区域与域名映射

有两个域名前缀（用于故障转移）和两个域名后缀。域名池从首个前缀 + 首个后缀开始，每 30 秒通过 DNS 解析最佳后缀，并以 https://{prefix}.{suffix}{path} 构造完整 URL。

区域	主前缀	备用前缀	主后缀	备用后缀	路径
`option.AreaCN`	`api-cn-east-1`	`api-cn-north-1`	`sd-rtn.com`	`agora.io`	`/cn/api/conversational-ai-agent`

注意：option.AreaCN 使用 sd-rtn.com 作为主后缀，并走 /cn/api/conversational-ai-agent 路径。

类型别名

agentkit 包为常见请求与响应类型定义了类型别名。在构造配置对象时，建议优先使用这些别名，而不是完整的 Agora.StartAgentsRequestProperties* 名称。

别名	底层类型
`TurnDetectionConfig`	`Agora.StartAgentsRequestPropertiesTurnDetection`
`SalConfig`	`Agora.StartAgentsRequestPropertiesSal`
`AdvancedFeatures`	`Agora.StartAgentsRequestPropertiesAdvancedFeatures`
`SessionParams`	`Agora.StartAgentsRequestPropertiesParameters`
`GeofenceConfig`	`Agora.StartAgentsRequestPropertiesGeofence`
`RtcConfig`	`Agora.StartAgentsRequestPropertiesRtc`
`FillerWordsConfig`	`Agora.StartAgentsRequestPropertiesFillerWords`
`FillerWordsContentMode`	`Agora.StartAgentsRequestPropertiesFillerWordsContentMode`
`FillerWordsContentGeneratedConfig`	`Agora.StartAgentsRequestPropertiesFillerWordsContentGeneratedConfig`
`LlmTool`	`Agora.LlmTool`
`LlmToolFunction`	`Agora.LlmToolFunction`
`LlmToolFunctionParameters`	`Agora.LlmToolFunctionParameters`
`LlmToolExecution`	`Agora.LlmToolExecution`
`LlmToolServer`	`Agora.LlmToolServer`
`LlmConfig`	`Agora.StartAgentsRequestPropertiesLlm`
`MllmConfig`	`Agora.StartAgentsRequestPropertiesMllm`
`AsrConfig`	`Agora.StartAgentsRequestPropertiesAsr`
`TtsConfig`	`Agora.Tts`
`AvatarConfig`	`Agora.StartAgentsRequestPropertiesAvatar`
`SttConfig`	`AsrConfig`
`LlmStyle`	`Agora.StartAgentsRequestPropertiesLlmStyle`
`SessionInfo`	`Agora.GetAgentsResponse`
`ThinkResponse`	`Agora.AgentThinkAgentManagementResponse`

还有用于 SOS/EOS turn detection 的附加别名：TurnDetectionNestedConfig、StartOfSpeechConfig、EndOfSpeechConfig 以及相关子类型。会话/对话相关别名包括 SessionListResponse、ConversationHistory、ConversationTurns 等。think 相关别名包括 ThinkOnListeningAction、ThinkOnThinkingAction、ThinkOnSpeakingAction。

FillerWordsConfig 支持静态承接词和动态承接词。使用动态承接词时，必须同时配置非空的静态短语作为回退；GeneratedConfig 中的 Prompt、上下文限制和回退策略均为可选项，模型服务和凭证由声网托管。具体字段结构详见配置承接词。

动态承接词配置还支持 ContextMessageLimit（取值范围 1 到 6，省略时由服务按 1 处理）和 HistoryCharacterLimit（取值范围 0 到 10000，省略时由服务按 1000 处理）。前者包含当前用户消息，显式设置为 2 到 6 时启用近期历史；后者只统计历史消息文本的 Unicode code points。

`AgoraError`

当 API 返回 4xx 或 5xx 状态码时，底层 API 客户端会返回结构化错误类型。你可以使用 errors.As 对其进行判断和读取。

import "github.com/AgoraIO/agent-server-sdk-go/core"

_, err := session.Start(ctx)
if err != nil {
    var apiError *core.APIError
    if errors.As(err, &apiError) {
        log.Printf("Status: %d", apiError.StatusCode)
        log.Printf("Body: %s", apiError.Body)
    }
    return err
}

字段	类型	说明
`StatusCode`	`int`	API 返回的 HTTP 状态码
`Body`	`string`	API 返回的原始响应体

client.NewClientCopy Anchor Link

构造函数Copy Anchor Link

ClientOptionsCopy Anchor Link

请求选项Copy Anchor Link

option.WithAreaCopy Anchor Link

option.WithBaseURLCopy Anchor Link

option.WithHTTPClientCopy Anchor Link

option.WithMaxAttemptsCopy Anchor Link

option.WithHTTPHeaderCopy Anchor Link

option.WithBodyPropertiesCopy Anchor Link

option.WithQueryParametersCopy Anchor Link

option.WithPoolCopy Anchor Link

子客户端Copy Anchor Link

环境Copy Anchor Link

指针辅助函数Copy Anchor Link

agentkit.NewAgentCopy Anchor Link

构造函数Copy Anchor Link

AgentOption 配置函数Copy Anchor Link

服务商链式配置方法Copy Anchor Link

WithLlm(vendor)Copy Anchor Link

WithTts(vendor)Copy Anchor Link

WithStt(vendor)Copy Anchor Link

WithAvatar(vendor)Copy Anchor Link

WithTurnDetection(config)Copy Anchor Link

其他构建方法Copy Anchor Link

ToProperties()Copy Anchor Link

ToPropertiesOptionsCopy Anchor Link

属性获取方法Copy Anchor Link

agentkit.NewAgentSessionCopy Anchor Link

CreateSession（推荐）Copy Anchor Link

构造函数Copy Anchor Link

AgentSessionOptionsCopy Anchor Link

状态机Copy Anchor Link

方法Copy Anchor Link

Start(ctx)Copy Anchor Link

Stop(ctx)Copy Anchor Link

Say(ctx, text, priority, interruptable)Copy Anchor Link

Interrupt(ctx)Copy Anchor Link

Update(ctx, properties)Copy Anchor Link

GetHistory(ctx)Copy Anchor Link

GetTurns(ctx) / GetAllTurns(ctx)Copy Anchor Link

GetInfo(ctx)Copy Anchor Link

Think(ctx)Copy Anchor Link

On(event, handler)Copy Anchor Link

Off(event, handler)Copy Anchor Link

事件Copy Anchor Link

属性获取方法Copy Anchor Link

使用 session.Raw()Copy Anchor Link

线程安全Copy Anchor Link

服务商Copy Anchor Link

接口Copy Anchor Link

LLM 服务商Copy Anchor Link

语音识别服务商Copy Anchor Link

NewFengmingSTTCopy Anchor Link

NewTencentSTTCopy Anchor Link

NewMicrosoftSTTCopy Anchor Link

语音合成服务商Copy Anchor Link

NewMiniMaxTTSCopy Anchor Link

NewTencentTTSCopy Anchor Link

NewMicrosoftTTSCopy Anchor Link

NewGenericTTSCopy Anchor Link

NewBytedanceTTSCopy Anchor Link

NewCosyVoiceTTSCopy Anchor Link

NewBytedanceDuplexTTSCopy Anchor Link

NewStepFunTTSCopy Anchor Link

数字人服务商Copy Anchor Link

NewSensetimeAvatarCopy Anchor Link

NewSpatiusAvatarCopy Anchor Link

Token 工具Copy Anchor Link

GenerateConvoAIToken()Copy Anchor Link

GenerateRtcTokenWithAccount()Copy Anchor Link

GenerateRtcToken()Copy Anchor Link

ExpiresInHours() / ExpiresInMinutes()Copy Anchor Link

类型与常量Copy Anchor Link

SessionStatusCopy Anchor Link

SampleRateCopy Anchor Link

EventHandlerCopy Anchor Link

区域常量Copy Anchor Link

区域与域名映射Copy Anchor Link

类型别名Copy Anchor Link

client.NewClient

构造函数

ClientOptions

请求选项

`option.WithArea`

`option.WithBaseURL`

`option.WithHTTPClient`

`option.WithMaxAttempts`

`option.WithHTTPHeader`

`option.WithBodyProperties`

`option.WithQueryParameters`

`option.WithPool`

子客户端

环境

指针辅助函数

agentkit.NewAgent

构造函数

AgentOption 配置函数

服务商链式配置方法

`WithLlm(vendor)`

`WithTts(vendor)`

`WithStt(vendor)`

`WithAvatar(vendor)`

`WithTurnDetection(config)`

其他构建方法

`ToProperties()`

ToPropertiesOptions

属性获取方法

agentkit.NewAgentSession

`CreateSession`（推荐）

构造函数

AgentSessionOptions

状态机

方法

`Start(ctx)`

`Stop(ctx)`

`Say(ctx, text, priority, interruptable)`

`Interrupt(ctx)`

`Update(ctx, properties)`

`GetHistory(ctx)`

`GetTurns(ctx)` / `GetAllTurns(ctx)`

`GetInfo(ctx)`

`Think(ctx)`

`On(event, handler)`

`Off(event, handler)`

事件

属性获取方法

使用 `session.Raw()`

线程安全

服务商

接口

LLM 服务商

语音识别服务商

`NewFengmingSTT`

`NewTencentSTT`

`NewMicrosoftSTT`

语音合成服务商

`NewMiniMaxTTS`

`NewTencentTTS`

`NewMicrosoftTTS`

`NewGenericTTS`

`NewBytedanceTTS`

`NewCosyVoiceTTS`

`NewBytedanceDuplexTTS`

`NewStepFunTTS`

数字人服务商

`NewSensetimeAvatar`

`NewSpatiusAvatar`

Token 工具

`GenerateConvoAIToken()`

`GenerateRtcTokenWithAccount()`

`GenerateRtcToken()`

`ExpiresInHours()` / `ExpiresInMinutes()`

类型与常量

`SessionStatus`

`SampleRate`

`EventHandler`

区域常量

区域与域名映射

类型别名