File knowledge bases
Reference for client.file_knowledge_bases in the Future AGI Python and TypeScript SDKs: file_knowledge_bases.create, file_knowledge_bases.delete, file_knowledge_bases.list, file_knowledge_bases.list_names, file_knowledge_bases.update, file_knowledge_bases.files.delete and 1 more.
client.file_knowledge_bases on fi.Client (Python) and client.fileKnowledgeBases on Client from @future-agi/sdk (TypeScript), with the nested resources client.file_knowledge_bases.files. 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 |
|---|---|
file_knowledge_bases.create | Create a file knowledge base (the Knowledge Base page of the app), optionally uploading its first files (pdf, docx, txt, rtf). |
file_knowledge_bases.delete | Delete file knowledge bases by id. |
file_knowledge_bases.list | List the file knowledge bases of the workspace as a table (name, file count, creator), without paging. |
file_knowledge_bases.list_names | Return the id and name of every file knowledge base, without paging. |
file_knowledge_bases.update | Rename a file knowledge base and/or upload more files to it. |
file_knowledge_bases.files.delete | Delete files from a file knowledge base, by id or name, or all of them. |
file_knowledge_bases.files.list | List the files in a file knowledge base, with their processing status. |
client.file_knowledge_bases
file_knowledge_bases.create
Create a file knowledge base (the Knowledge Base page of the app), optionally uploading its first files (pdf, docx, txt, rtf).
/model-hub/knowledge-base/ Multipart upload: file parameters take a path, bytes or an open file
result = client.file_knowledge_bases.create(name="your-name")const result = await client.fileKnowledgeBases.create({ name: "your-name" }); Signature
client.file_knowledge_bases.create(
*,
name: str,
files: list[FileInput] | None | NotGiven = NOT_GIVEN,
extra_query: dict[str, Any] | None = None,
extra_body: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> models.LegacyKnowledgeBaseCreateResultclient.fileKnowledgeBases.create(params: FileKnowledgeBasesCreateParams, options?: RequestOptions): Promise<models.LegacyKnowledgeBaseCreateResult>
export interface FileKnowledgeBasesCreateParams {
name: string;
file?: Array<FileInput>;
} Parameters
Returns
LegacyKnowledgeBaseCreateResult.
file_knowledge_bases.delete
Delete file knowledge bases by id.
/model-hub/knowledge-base/ result = client.file_knowledge_bases.delete()const result = await client.fileKnowledgeBases.delete(); Signature
client.file_knowledge_bases.delete(
*,
kb_ids: list[str] | None | NotGiven = NOT_GIVEN,
extra_query: dict[str, Any] | None = None,
extra_body: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> strclient.fileKnowledgeBases.delete(params: FileKnowledgeBasesDeleteParams = {}, options?: RequestOptions): Promise<string>
export interface FileKnowledgeBasesDeleteParams {
kb_ids?: Array<string> | null;
} Parameters
Returns
string.
file_knowledge_bases.list
List the file knowledge bases of the workspace as a table (name, file count, creator), without paging.
/model-hub/knowledge-base/get/ result = client.file_knowledge_bases.list()const result = await client.fileKnowledgeBases.list(); Signature
client.file_knowledge_bases.list(
*,
extra_query: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> models.LegacyKnowledgeBaseTableResultclient.fileKnowledgeBases.list(options?: RequestOptions): Promise<models.LegacyKnowledgeBaseTableResult> Parameters
This method takes no parameters beyond the per-call options.
Returns
LegacyKnowledgeBaseTableResult.
file_knowledge_bases.list_names
Return the id and name of every file knowledge base, without paging.
/model-hub/knowledge-base/list/ result = client.file_knowledge_bases.list_names()const result = await client.fileKnowledgeBases.listNames(); Signature
client.file_knowledge_bases.list_names(
*,
extra_query: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> models.LegacyKnowledgeBaseListResultclient.fileKnowledgeBases.listNames(options?: RequestOptions): Promise<models.LegacyKnowledgeBaseListResult> Parameters
This method takes no parameters beyond the per-call options.
Returns
LegacyKnowledgeBaseListResult.
file_knowledge_bases.update
Rename a file knowledge base and/or upload more files to it.
/model-hub/knowledge-base/ Multipart upload: file parameters take a path, bytes or an open file
result = client.file_knowledge_bases.update(kb_id="your-kb-id")const result = await client.fileKnowledgeBases.update({ kb_id: "your-kb-id" }); Signature
client.file_knowledge_bases.update(
*,
kb_id: str,
name: str | None | NotGiven = NOT_GIVEN,
files: list[FileInput] | None | NotGiven = NOT_GIVEN,
extra_query: dict[str, Any] | None = None,
extra_body: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> models.LegacyKnowledgeBaseMutationResultclient.fileKnowledgeBases.update(params: FileKnowledgeBasesUpdateParams, options?: RequestOptions): Promise<models.LegacyKnowledgeBaseMutationResult>
export interface FileKnowledgeBasesUpdateParams {
kb_id: string;
name?: string | null;
file?: Array<FileInput>;
} Parameters
Returns
LegacyKnowledgeBaseMutationResult.
client.file_knowledge_bases.files
TypeScript: client.fileKnowledgeBases.files.
file_knowledge_bases.files.delete
Delete files from a file knowledge base, by id or name, or all of them.
/model-hub/knowledge-base/files/ result = client.file_knowledge_bases.files.delete()const result = await client.fileKnowledgeBases.files.delete(); Signature
client.file_knowledge_bases.files.delete(
*,
kb_id: str | None | NotGiven = NOT_GIVEN,
delete_all: bool | None | NotGiven = NOT_GIVEN,
file_ids: list[str] | None | NotGiven = NOT_GIVEN,
excluded_file_ids: list[str] | None | NotGiven = NOT_GIVEN,
file_names: list[str] | None | NotGiven = NOT_GIVEN,
extra_query: dict[str, Any] | None = None,
extra_body: dict[str, Any] | None = None,
options: RequestOptions | None = None,
) -> strclient.fileKnowledgeBases.files.delete(params: FileKnowledgeBasesFilesDeleteParams = {}, options?: RequestOptions): Promise<string>
export interface FileKnowledgeBasesFilesDeleteParams {
kb_id?: string | null;
delete_all?: boolean | null;
file_ids?: Array<string> | null;
excluded_file_ids?: Array<string> | null;
file_names?: Array<string> | null;
} Parameters
Returns
string.
file_knowledge_bases.files.list
List the files in a file knowledge base, with their processing status.
/model-hub/knowledge-base/files/ result = client.file_knowledge_bases.files.list(kb_id="your-kb-id")const result = await client.fileKnowledgeBases.files.list({ kb_id: "your-kb-id" }); Signature
client.file_knowledge_bases.files.list(
*,
kb_id: str,
search: str | None | NotGiven = NOT_GIVEN,
sort: list[dict[str, Any]] | None | NotGiven = NOT_GIVEN,
page_number: int | None | NotGiven = NOT_GIVEN,
page_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.LegacyKnowledgeBaseFilesResultclient.fileKnowledgeBases.files.list(params: FileKnowledgeBasesFilesListParams, options?: RequestOptions): Promise<models.LegacyKnowledgeBaseFilesResult>
export interface FileKnowledgeBasesFilesListParams {
kb_id: string;
search?: string | null;
sort?: Array<Record<string, unknown>> | null;
page_number?: number | null;
page_size?: number | null;
} Parameters
Returns
Questions & Discussion