AS AgentScopeAPI 手册 / API Reference

Builder

public static class Builder
源码Source io/agentscope/extensions/mongodb/state/MongoAgentStateStore.java:630–729

MongoAgentStateStore的构建器。位于 io.agentscope.extensions.mongodb.state 包。核心成员包括 mongoClient、connectionString、databaseName、collectionName、ttlDays、onDeleteCallback。

Builder for MongoAgentStateStore.

方法摘要Method Summary

方法Method说明Description
public Builder mongoClient(MongoClient mongoClient)
设置该配置项。
Use an existing `MongoClient`.
public Builder connectionString(String connectionString)
设置该配置项。
MongoDB connection string (e.g.
public Builder databaseName(String databaseName)
设置数据库名称。
Database name.
public Builder collectionName(String collectionName)
设置集合名称。
Collection name.
public Builder ttlDays(Integer ttlDays)
设置该配置项。
Optional session TTL in days.
public Builder onDeleteCallback(BiConsumer<String, String> onDeleteCallback)
处理删除回调事件。
Optional callback invoked before a session document is deleted via `MongoAgentStateStore#delete(String, String)`.
public MongoAgentStateStore build()
构建`MongoAgentStateStore`。
Build the `MongoAgentStateStore`.

方法详情Method Detail

mongoClient

public Builder mongoClient(MongoClient mongoClient)

设置该配置项。

Use an existing MongoClient.

参数Parameters
名称Name类型Type说明Description
mongoClientMongoClient客户端到使用。the client to use
返回Returns Builder
返回当前实例,以支持链式调用。this builder
源码Source io/agentscope/extensions/mongodb/state/MongoAgentStateStore.java:645–648

connectionString

public Builder connectionString(String connectionString)

设置该配置项。

MongoDB connection string (e.g.

参数Parameters
名称Name类型Type说明Description
connectionStringString连接 String(类型 `String`)。the connection string
返回Returns Builder
返回当前实例,以支持链式调用。this builder
源码Source io/agentscope/extensions/mongodb/state/MongoAgentStateStore.java:659–662

databaseName

public Builder databaseName(String databaseName)

设置数据库名称。

Database name.

参数Parameters
名称Name类型Type说明Description
databaseNameString数据库名称。the database name
返回Returns Builder
返回当前实例,以支持链式调用。this builder
源码Source io/agentscope/extensions/mongodb/state/MongoAgentStateStore.java:672–675

collectionName

public Builder collectionName(String collectionName)

设置集合名称。

Collection name.

参数Parameters
名称Name类型Type说明Description
collectionNameString集合名称。the collection name
返回Returns Builder
返回当前实例,以支持链式调用。this builder
源码Source io/agentscope/extensions/mongodb/state/MongoAgentStateStore.java:683–686

ttlDays

public Builder ttlDays(Integer ttlDays)

设置该配置项。

Optional session TTL in days.

参数Parameters
名称Name类型Type说明Description
ttlDaysInteger存活时间 Days(类型 `Integer`)。number of days, or `null` to disable automatic expiry
返回Returns Builder
返回当前实例,以支持链式调用。this builder
源码Source io/agentscope/extensions/mongodb/state/MongoAgentStateStore.java:699–705

onDeleteCallback

public Builder onDeleteCallback(BiConsumer<String, String> onDeleteCallback)

处理删除回调事件。

Optional callback invoked before a session document is deleted via MongoAgentStateStore#delete(String, String).

参数Parameters
名称Name类型Type说明Description
onDeleteCallbackBiConsumer<String, String>on 删除回调(类型 `BiConsumer`)。the callback (userId, sessionId) to run before session deletion
返回Returns Builder
返回当前实例,以支持链式调用。this builder
源码Source io/agentscope/extensions/mongodb/state/MongoAgentStateStore.java:716–719

build

public MongoAgentStateStore build()

构建MongoAgentStateStore。

Build the MongoAgentStateStore.

返回Returns MongoAgentStateStore
一种新的实例。a new instance
源码Source io/agentscope/extensions/mongodb/state/MongoAgentStateStore.java:726–728
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.