v1

latestOpenAPI 3.0.22026-07-173834119.9 KB
Vectorization

Vectorize And Store Chunk

Endpoint to Vectorize and Store Chunks.

This endpoint triggers the vectorization and storage of chunks. It takes a reference to the chunking job that was completed and triggers the vectorization of the chunks.


Request Body

FieldTypeDescription
chunking_job_idstrThe ID of the chunking job.
index_idstrThe ID of the index to store the vectors.

Example Request Body

    ```json

    {
        "chunking_job_id": "b1c2b4c5-6d7e-8f9g-0h1i-2j3k4l5m6n7",
        "index_id": "b1c2b4c5-6d7e-8f9g-0h1i-2j3k4l5m6n7"
    }

    ```

Response Body

FieldTypeDescription
vectorize_job_idstrThe ID of the vectorization job.
vector_store_idstrThe ID of the vector store.
index_idstrThe ID of the index.
chunking_job_idstrThe ID of the chunking job.
total_file_countintThe total number of files to be vectorized.
completed_file_countintThe number of files that have been vectorized.
failed_file_countintThe number of files that failed to be vectorized.
statusstrThe status of the vectorization job.

Errors

  • 400 Bad Request: If the index or chunking job is not found.
  • 500 Internal Server Error: If there is an unexpected error during the vectorization process.
post/vector/store/vectorize

Request body

chunking_job_idstring required
index_idstring required

Response

Successful Response

vectorize_job_idstring required
vector_store_idstring required
index_idstring required
chunking_job_idstring required
total_file_countinteger required
completed_file_countinteger required
failed_file_countinteger required
statusstring required