Ingestion
Ingesting files with R2R.
Document Ingestion and Management
Ingest Files
Ingest files or directories into your R2R system:
const files = [
{ path: 'path/to/file1.txt', name: 'file1.txt' },
{ path: 'path/to/file2.txt', name: 'file2.txt' }
];
const metadatas = [{ key1: 'value1' }, { key2: 'value2' }];
const ingestResponse = await client.ingestFiles(files, {
metadatas,
user_ids: ['user-id-1', 'user-id-2'],
});
An array of file paths, File objects, or objects with path and name properties to ingest.
An optional array of metadata objects corresponding to each file.
An optional array of document IDs to assign to the ingested files.
An optional array of user IDs associated with the ingested files.
The ingestion config override parameter enables developers to customize their R2R chunking strategy at runtime.
Update Files
Update existing documents:
const files = [
{ path: '/path/to/updated_file1.txt', name: 'updated_file1.txt' }
];
const document_ids = ['document-id-1'];
const updateResponse = await client.updateFiles(files, {
document_ids,
metadatas: [{ key: 'updated_value' }] // to overwrite the existing metadata
});
An array of File objects or objects with path and name properties to update.
An array of document IDs corresponding to the files being updated.
An optional array of metadata objects for the updated files.
The ingestion config override parameter enables developers to customize their R2R chunking strategy at runtime.
Documents Overview
Retrieve high-level document information, restricted to user files, except when called by a superuser where it will then return results from over all users:
const documentsOverview = await client.documentsOverview();
An optional array of document IDs to filter the overview.
Document Chunks
Fetch chunks for a particular document:
const documentId = '9fbe403b-c11c-5aae-8ade-ef22980c3ad1';
const chunks = await client.documentChunks(documentId);
The ID of the document to retrieve chunks for.
Delete Documents
Delete a document by its ID:
const deleteResponse = await client.delete({ document_id: "91662726-7271-51a5-a0ae-34818509e1fd" });
A list of logical filters to perform over input documents fields which identifies the unique set of documents to delete (e.g., {"document_id": {"$eq": "9fbe403b-c11c-5aae-8ade-ef22980c3ad1"}}
). Logical operations might include variables such as "user_id"
or "title"
and filters like neq
, gte
, etc.
Was this page helpful?