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

MethodDescription
knowledge_bases.createCreate 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.deleteDelete a knowledge base.
knowledge_bases.getReturn a knowledge base and its configuration.
knowledge_bases.listList knowledge bases (the RAG stores with an embedding model and a chunk size) in the current workspace.
knowledge_bases.updateUpdate 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.

POST /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.KnowledgeBaseItem
client.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

name string Required
chunk_size integer Required
embedding_model string Optional
Allowed values:
BAAI/bge-small-en-v1.5

Returns

KnowledgeBaseItem.

knowledge_bases.delete

Delete a knowledge base.

DELETE /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,
) -> Any
client.knowledgeBases.delete(id: string, options?: RequestOptions): Promise<unknown>

Parameters

id string Required

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.

GET /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.KnowledgeBaseItem
client.knowledgeBases.get(id: string, options?: RequestOptions): Promise<models.KnowledgeBaseItem>

Parameters

id string Required

A UUID string identifying this knowledge base.

Returns

KnowledgeBaseItem.

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.

GET /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

search string Optional

A search term.

limit integer Optional

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).

PATCH /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.KnowledgeBaseItem
client.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

id string Required

A UUID string identifying this knowledge base.

name string Optional
embedding_model string Optional
Allowed values:
BAAI/bge-small-en-v1.5
chunk_size integer Optional

Returns

KnowledgeBaseItem.

Was this page helpful?

Questions & Discussion