Document Store

Create a new document store

Creates a new document store with the provided details

POST/document-store/store

Authorization

bearerAuth

Body

application/json

idstring (uuid)

Unique identifier for the document store

namestring

Name of the document store

descriptionstring

Description of the document store

loadersstring

Loaders associated with the document store, stored as JSON string

whereUsedstring

Places where the document store is used, stored as JSON string

statusenum

Status of the document store

EMPTYSYNCSYNCINGSTALENEWUPSERTINGUPSERTED

vectorStoreConfigstring

Configuration for the vector store, stored as JSON string

embeddingConfigstring

Configuration for the embedding, stored as JSON string

recordManagerConfigstring

Configuration for the record manager, stored as JSON string

createdDatestring (date-time)

Date and time when the document store was created

updatedDatestring (date-time)

Date and time when the document store was last updated

Response

200400500

Successfully created document store

Body

application/json

idstring (uuid)

Unique identifier for the document store

namestring

Name of the document store

descriptionstring

Description of the document store

loadersstring

Loaders associated with the document store, stored as JSON string

whereUsedstring

Places where the document store is used, stored as JSON string

statusenum

Status of the document store

EMPTYSYNCSYNCINGSTALENEWUPSERTINGUPSERTED

vectorStoreConfigstring

Configuration for the vector store, stored as JSON string

embeddingConfigstring

Configuration for the embedding, stored as JSON string

recordManagerConfigstring

Configuration for the record manager, stored as JSON string

createdDatestring (date-time)

Date and time when the document store was created

updatedDatestring (date-time)

Date and time when the document store was last updated

Request

JavaScriptCurlPython

const response = await fetch('/document-store/store', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2024-12-21T12:27:50.621Z",
  "updatedDate": "2024-12-21T12:27:50.621Z"
}

List all document stores

Retrieves a list of all document stores

GET/document-store/store

Authorization

bearerAuth

Response

200500content

A list of document stores

Request

JavaScriptCurlPython

const response = await fetch('/document-store/store', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Get a specific document store

Retrieves details of a specific document store by its ID

GET/document-store/store/{id}

Authorization

bearerAuth

Path parameters

id*string (uuid)

Document store ID

Response

200404500

Successfully retrieved document store

Body

application/json

idstring (uuid)

Unique identifier for the document store

namestring

Name of the document store

descriptionstring

Description of the document store

loadersstring

Loaders associated with the document store, stored as JSON string

whereUsedstring

Places where the document store is used, stored as JSON string

statusenum

Status of the document store

EMPTYSYNCSYNCINGSTALENEWUPSERTINGUPSERTED

vectorStoreConfigstring

Configuration for the vector store, stored as JSON string

embeddingConfigstring

Configuration for the embedding, stored as JSON string

recordManagerConfigstring

Configuration for the record manager, stored as JSON string

createdDatestring (date-time)

Date and time when the document store was created

updatedDatestring (date-time)

Date and time when the document store was last updated

Request

JavaScriptCurlPython

const response = await fetch('/document-store/store/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2024-12-21T12:27:50.621Z",
  "updatedDate": "2024-12-21T12:27:50.621Z"
}

Update a specific document store

Updates the details of a specific document store by its ID

PUT/document-store/store/{id}

Authorization

bearerAuth

Path parameters

id*string (uuid)

Document store ID

Body

application/json

idstring (uuid)

Unique identifier for the document store

namestring

Name of the document store

descriptionstring

Description of the document store

loadersstring

Loaders associated with the document store, stored as JSON string

whereUsedstring

Places where the document store is used, stored as JSON string

statusenum

Status of the document store

EMPTYSYNCSYNCINGSTALENEWUPSERTINGUPSERTED

vectorStoreConfigstring

Configuration for the vector store, stored as JSON string

embeddingConfigstring

Configuration for the embedding, stored as JSON string

recordManagerConfigstring

Configuration for the record manager, stored as JSON string

createdDatestring (date-time)

Date and time when the document store was created

updatedDatestring (date-time)

Date and time when the document store was last updated

Response

200404500

Successfully updated document store

Body

application/json

idstring (uuid)

Unique identifier for the document store

namestring

Name of the document store

descriptionstring

Description of the document store

loadersstring

Loaders associated with the document store, stored as JSON string

whereUsedstring

Places where the document store is used, stored as JSON string

statusenum

Status of the document store

EMPTYSYNCSYNCINGSTALENEWUPSERTINGUPSERTED

vectorStoreConfigstring

Configuration for the vector store, stored as JSON string

embeddingConfigstring

Configuration for the embedding, stored as JSON string

recordManagerConfigstring

Configuration for the record manager, stored as JSON string

createdDatestring (date-time)

Date and time when the document store was created

updatedDatestring (date-time)

Date and time when the document store was last updated

Request

JavaScriptCurlPython

const response = await fetch('/document-store/store/{id}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "description": "text",
  "loaders": "text",
  "whereUsed": "text",
  "status": "EMPTY",
  "vectorStoreConfig": "text",
  "embeddingConfig": "text",
  "recordManagerConfig": "text",
  "createdDate": "2024-12-21T12:27:50.621Z",
  "updatedDate": "2024-12-21T12:27:50.621Z"
}

Delete a specific document store

Deletes a document store by its ID

DELETE/document-store/store/{id}

Authorization

bearerAuth

Path parameters

id*string (uuid)

Document store ID

Response

200404500

Successfully deleted document store

Request

JavaScriptCurlPython

const response = await fetch('/document-store/store/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Upsert new document to document store

Upsert new document to document store

POST/document-store/upsert/{id}

Authorization

bearerAuth

Path parameters

id*string (uuid)

Document store ID

Body

application/jsonmultipart/form-data

docIdstring (uuid)

Document ID within the store. If provided, existing configuration from the document will be used for the new document

loaderobject

splitterobject

embeddingobject

vectorStoreobject

recordManagerobject

Response

200400500

Successfully execute upsert operation

Body

application/json

numAddednumber

Number of vectors added

Example: 1

numDeletednumber

Number of vectors deleted

Example: 1

numUpdatednumber

Number of vectors updated

Example: 1

numSkippednumber

Number of vectors skipped (not added, deleted, or updated)

Example: 1

addedDocsarray of Document (object)

Request

JavaScriptCurlPython

const response = await fetch('/document-store/upsert/{id}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "numAdded": 1,
  "numDeleted": 1,
  "numUpdated": 1,
  "numSkipped": 1,
  "addedDocs": [
    {
      "pageContent": "This is the content of the page.",
      "metadata": {
        "author": "John Doe",
        "date": "2024-08-24"
      }
    }
  ]
}

Re-process and upsert all documents in document store

Re-process and upsert all existing documents in document store

POST/document-store/refresh/{id}

Authorization

bearerAuth

Path parameters

id*string (uuid)

Document store ID

Body

application/json

itemsarray of DocumentStoreLoaderForUpsert (object)

Response

200400500

Successfully execute refresh operation

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/document-store/refresh/{id}', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Retrieval query

Retrieval query for the upserted chunks

POST/document-store/vectorstore/query

Authorization

bearerAuth

Body

application/json

storeId*string

Document store ID

Example: "603a7b51-ae7c-4b0a-8865-e454ed2f6766"

query*string

Query to search for

Example: "What is the capital of France?"

Response

200400500

Successfully executed query on vector store

Body

application/json

timeTakennumber

Time taken to execute the query (in milliseconds)

docsarray of Document (object)

Request

JavaScriptCurlPython

const response = await fetch('/document-store/vectorstore/query', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "storeId": "603a7b51-ae7c-4b0a-8865-e454ed2f6766",
      "query": "What is the capital of France?"
    }),
});
const data = await response.json();

Response

200

{
  "timeTaken": 0,
  "docs": [
    {
      "pageContent": "This is the content of the page.",
      "metadata": {
        "author": "John Doe",
        "date": "2024-08-24"
      }
    }
  ]
}

Delete specific document loader and associated chunks from document store

Delete specific document loader and associated chunks from document store. This does not delete data from vector store.

DELETE/document-store/loader/{storeId}/{loaderId}

Authorization

bearerAuth

Path parameters

storeId*string

Document Store ID

loaderId*string

Document Loader ID

Response

200400404500

Successfully deleted loader from document store

Request

JavaScriptCurlPython

const response = await fetch('/document-store/loader/{storeId}/{loaderId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Delete data from vector store

Only data that were upserted with Record Manager will be deleted from vector store

DELETE/document-store/vectorstore/{id}

Authorization

bearerAuth

Path parameters

id*string

Document Store ID

Response

200400404500

Successfully deleted data from vector store

Request

JavaScriptCurlPython

const response = await fetch('/document-store/vectorstore/{id}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Get chunks from a specific document loader

Get chunks from a specific document loader within a document store

GET/document-store/chunks/{storeId}/{loaderId}/{pageNo}

Authorization

bearerAuth

Path parameters

storeId*string (uuid)

Document Store ID

loaderId*string (uuid)

Document loader ID

pageNo*string

Pagination number

Response

200404500

Successfully retrieved chunks from document loader

Body

application/json

chunksarray of DocumentStoreFileChunk (object)

countnumber

Example: 1

fileDocumentStoreLoaderForPreview (object)

currentPagenumber

storeNamestring

descriptionstring

Request

JavaScriptCurlPython

const response = await fetch('/document-store/chunks/{storeId}/{loaderId}/{pageNo}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200

{
  "chunks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "docId": "123e4567-e89b-12d3-a456-426614174000",
      "storeId": "123e4567-e89b-12d3-a456-426614174000",
      "chunkNo": 0,
      "pageContent": "text",
      "metadata": "text"
    }
  ],
  "count": 1,
  "file": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "loaderId": "text",
    "loaderName": "text",
    "splitterId": "text",
    "splitterName": "text",
    "totalChunks": 0,
    "totalChars": 0,
    "status": "EMPTY",
    "storeId": "text",
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "mimePrefix": "text",
        "size": 0,
        "status": "EMPTY",
        "uploaded": "2024-12-21T12:27:50.621Z"
      }
    ],
    "source": "text",
    "credential": "text",
    "rehydrated": false,
    "preview": false,
    "previewChunkCount": 0
  },
  "currentPage": 0,
  "storeName": "text",
  "description": "text"
}

Update a specific chunk

Updates a specific chunk from a document loader

PUT/document-store/chunks/{storeId}/{loaderId}/{chunkId}

Authorization

bearerAuth

Path parameters

storeId*string

Document Store ID

loaderId*string

Document Loader ID

chunkId*string

Document Chunk ID

Body

application/json

pageContentstring

Example: "This is the content of the page."

metadataobject

Response

200404500

Successfully updated chunk

Body

application/json

chunksarray of DocumentStoreFileChunk (object)

countnumber

Example: 1

fileDocumentStoreLoaderForPreview (object)

currentPagenumber

storeNamestring

descriptionstring

Request

JavaScriptCurlPython

const response = await fetch('/document-store/chunks/{storeId}/{loaderId}/{chunkId}', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "chunks": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "docId": "123e4567-e89b-12d3-a456-426614174000",
      "storeId": "123e4567-e89b-12d3-a456-426614174000",
      "chunkNo": 0,
      "pageContent": "text",
      "metadata": "text"
    }
  ],
  "count": 1,
  "file": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "loaderId": "text",
    "loaderName": "text",
    "splitterId": "text",
    "splitterName": "text",
    "totalChunks": 0,
    "totalChars": 0,
    "status": "EMPTY",
    "storeId": "text",
    "files": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "mimePrefix": "text",
        "size": 0,
        "status": "EMPTY",
        "uploaded": "2024-12-21T12:27:50.621Z"
      }
    ],
    "source": "text",
    "credential": "text",
    "rehydrated": false,
    "preview": false,
    "previewChunkCount": 0
  },
  "currentPage": 0,
  "storeName": "text",
  "description": "text"
}

Delete a specific chunk from a document loader

Delete a specific chunk from a document loader

DELETE/document-store/chunks/{storeId}/{loaderId}/{chunkId}

Authorization

bearerAuth

Path parameters

storeId*string

Document Store ID

loaderId*string

Document Loader ID

chunkId*string

Document Chunk ID

Response

200400404500

Successfully deleted chunk

Request

JavaScriptCurlPython

const response = await fetch('/document-store/chunks/{storeId}/{loaderId}/{chunkId}', {
    method: 'DELETE',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();