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-09-16T18:53:39.486Z",
  "updatedDate": "2024-09-16T18:53:39.486Z"
}

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-09-16T18:53:39.486Z",
  "updatedDate": "2024-09-16T18:53:39.486Z"
}

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-09-16T18:53:39.486Z",
  "updatedDate": "2024-09-16T18:53:39.486Z"
}

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();

Preview document chunks

Preview document chunks from loader

POST/document-store/loader/preview

Authorization

bearerAuth

Body

application/json

idstring (uuid)

Unique identifier for the document store loader

loaderIdstring

ID of the loader

loaderNamestring

Name of the loader

loaderConfigobject

Configuration for the loader

splitterIdstring

ID of the text splitter

splitterNamestring

Name of the text splitter

splitterConfigobject

Configuration for the text splitter

totalChunksnumber

Total number of chunks

totalCharsnumber

Total number of characters

statusenum

Status of the document store loader

EMPTYSYNCSYNCINGSTALENEWUPSERTINGUPSERTED

storeIdstring

ID of the document store

filesarray of DocumentStoreLoaderFile (object)

sourcestring

Source of the document store loader

credentialstring

Credential associated with the document store loader

rehydratedboolean

Whether the loader has been rehydrated

previewboolean

Whether the loader is in preview mode

previewChunkCountnumber

Number of chunks in preview mode

Response

200400500

Successfully preview chunks

Body

application/json

chunksarray of Document (object)

totalChunksinteger

Example: 10

previewChunkCountinteger

Example: 5

Request

JavaScriptCurlPython

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

Response

200

{
  "chunks": [
    {
      "pageContent": "This is the content of the page.",
      "metadata": {
        "author": "John Doe",
        "date": "2024-08-24"
      }
    }
  ],
  "totalChunks": 10,
  "previewChunkCount": 5
}

Process loading & chunking operation

Process loading & chunking operation of document from loader

POST/document-store/loader/process

Authorization

bearerAuth

Body

application/json

storeId*string

Document store ID

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

id*string

Document loader ID. If your URL is /document-stores/{storeId}/{id}, then id is the last part of the URL

Example: "c427e569-b81a-469a-b14c-fa73dd5bae49"

Response

200400500

Successfully process chunking operation

Body

application/json

chunksarray of DocumentStoreFileChunk (object)

countnumber

Example: 1

fileDocumentStoreLoaderForPreview (object)

currentPagenumber

storeNamestring

descriptionstring

Request

JavaScriptCurlPython

const response = await fetch('/document-store/loader/process', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "storeId": "603a7b51-ae7c-4b0a-8865-e454ed2f6766",
      "id": "c427e569-b81a-469a-b14c-fa73dd5bae49"
    }),
});
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",
      "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-09-16T18:53:39.486Z"
      }
    ],
    "source": "text",
    "credential": "text",
    "rehydrated": false,
    "preview": false,
    "previewChunkCount": 0
  },
  "currentPage": 0,
  "storeName": "text",
  "description": "text"
}

Save upsert configuration of document store

Save upsert configuration of document store

POST/document-store/vectorstore/save

Authorization

bearerAuth

Body

application/json

storeId*string

Document store ID

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

embeddingNamestring

Name of the embedding

Example: "openAIEmbeddings"

embeddingConfigobject

Configuration of the embedding

vectorStoreNamestring

Name of the vector store

Example: "faiss"

vectorStoreConfigobject

Configuration of the embedding

recordManagerNamestring

Name of the record manager

Example: "SQLiteRecordManager"

recordManagerConfigobject

Configuration of the embedding

Response

200400500

Successfully save upsert configuration of 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/vectorstore/save', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "storeId": "603a7b51-ae7c-4b0a-8865-e454ed2f6766"
    }),
});
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-09-16T18:53:39.486Z",
  "updatedDate": "2024-09-16T18:53:39.486Z"
}

Upsert chunks from document store

Upsert chunks from document store using the saved configuration

POST/document-store/vectorstore/insert

Authorization

bearerAuth

Body

application/json

storeId*string

Document store ID

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

Response

200400500

Successfully save upsert configuration of document store

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/vectorstore/insert', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "storeId": "603a7b51-ae7c-4b0a-8865-e454ed2f6766"
    }),
});
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"
      }
    }
  ]
}

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 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();