Knowledge bases
Reference for client.knowledge_bases in the Future AGI Python and TypeScript SDKs: knowledge_bases.create, knowledge_bases.delete, knowledge_bases.get, knowledge_bases.list, knowledge_bases.update.
client.knowledge_bases on fi.Client (Python) and client.knowledgeBases on Client from @future-agi/sdk (TypeScript). The models these methods return are on Knowledge bases response models; how arguments, pagination, errors and strict mode work is in the overview.
Methods
| Method | Description |
|---|---|
knowledge_bases.create | Create a knowledge base with a name, an embedding model and a chunk size; it appears in knowledge_bases.list and knowledge_bases.get. |
knowledge_bases.delete | Delete a knowledge base. |
knowledge_bases.get | Return a knowledge base and its configuration. |
knowledge_bases.list | List knowledge bases (the RAG stores with an embedding model and a chunk size) in the current workspace. |
knowledge_bases.update | Update the name, embedding model or chunk size of a knowledge base (a partial update). |
client.knowledge_bases
knowledge_bases.create
Create a knowledge base with a name, an embedding model and a chunk size; it appears in knowledge_bases.list and knowledge_bases.get.
/model-hub/kb/ result = client.knowledge_bases.create(name="your-name", chunk_size=1)const result = await client.knowledgeBases.create({
name: "your-name",
chunk_size: 1,
}); Signature
client.knowledge_bases.create(
*,
name: str,
chunk_size: int,
embedding_model: Literal['BAAI/bge-small-en-v1.5'] | None | NotGiven = NOT_GIVEN,
extra_query: dict[str, Any] | None = None,
extra_body: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> models.KnowledgeBaseItemclient.knowledgeBases.create(params: KnowledgeBasesCreateParams, options?: RequestOptions): Promise<models.KnowledgeBaseItem>
export interface KnowledgeBasesCreateParams {
name: string;
chunk_size: number;
embedding_model?: "BAAI/bge-small-en-v1.5" | null;
} Parameters
BAAI/bge-small-en-v1.5 Returns
knowledge_bases.delete
Delete a knowledge base.
/model-hub/kb/{id}/ result = client.knowledge_bases.delete("your-id")const result = await client.knowledgeBases.delete("your-id"); Signature
client.knowledge_bases.delete(
id: str,
*,
extra_query: dict[str, Any] | None = None,
extra_body: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> Anyclient.knowledgeBases.delete(id: string, options?: RequestOptions): Promise<unknown> Parameters
A UUID string identifying this knowledge base.
Returns
The decoded response. The contract does not describe its shape, so it is untyped.
knowledge_bases.get
Return a knowledge base and its configuration.
/model-hub/kb/{id}/ MCP tool: get_knowledge_base
result = client.knowledge_bases.get("your-id")const result = await client.knowledgeBases.get("your-id"); Signature
client.knowledge_bases.get(
id: str,
*,
extra_query: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> models.KnowledgeBaseItemclient.knowledgeBases.get(id: string, options?: RequestOptions): Promise<models.KnowledgeBaseItem> Parameters
A UUID string identifying this knowledge base.
Returns
knowledge_bases.list
List knowledge bases (the RAG stores with an embedding model and a chunk size) in the current workspace. Knowledge bases built from uploaded files are a separate store, see file_knowledge_bases.
/model-hub/kb/ Paginated: returns a pager (how pagination works) · MCP tool: list_knowledge_bases
for item in client.knowledge_bases.list():
print(item)for await (const item of client.knowledgeBases.list()) {
console.log(item);
} Signature
client.knowledge_bases.list(
*,
search: str | None | NotGiven = NOT_GIVEN,
limit: int | None | NotGiven = NOT_GIVEN,
extra_query: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> SyncPager[models.KnowledgeBaseItem]client.knowledgeBases.list(params: KnowledgeBasesListParams = {}, options?: RequestOptions): Pager<models.KnowledgeBaseItem>
export interface KnowledgeBasesListParams {
/** A search term. */
search?: string | null;
/** Number of results to return per page. */
limit?: number | null;
} Parameters
A search term.
Number of results to return per page.
The pager sends page itself; pass limit to change the page size.
Returns
A pager of KnowledgeBaseItem items: iterate it, or call to_list() (Python) / toArray() (TypeScript).
knowledge_bases.update
Update the name, embedding model or chunk size of a knowledge base (a partial update).
/model-hub/kb/{id}/ result = client.knowledge_bases.update("your-id")const result = await client.knowledgeBases.update("your-id"); Signature
client.knowledge_bases.update(
id: str,
*,
name: str | None | NotGiven = NOT_GIVEN,
embedding_model: Literal['BAAI/bge-small-en-v1.5'] | None | NotGiven = NOT_GIVEN,
chunk_size: int | None | NotGiven = NOT_GIVEN,
extra_query: dict[str, Any] | None = None,
extra_body: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> models.KnowledgeBaseItemclient.knowledgeBases.update(id: string, params: KnowledgeBasesUpdateParams = {}, options?: RequestOptions): Promise<models.KnowledgeBaseItem>
export interface KnowledgeBasesUpdateParams {
name?: string | null;
embedding_model?: "BAAI/bge-small-en-v1.5" | null;
chunk_size?: number | null;
} Parameters
A UUID string identifying this knowledge base.
BAAI/bge-small-en-v1.5 Returns
Questions & Discussion