BulkInsert

post https://api.us-east-1.relevance.ai/latest/datasets/{dataset_id}/documents/bulk_insert

Insert one or more documents.

This method is the same as /insert but provides support for more than one document to be inserted at a time.

For each insertion, if an _id is provided and a document with that ID already exists, all existing field values will be deleted and the new ones will be stored. If no _id field is provided, one will automatically be added to the document.

This method will entirely replace the documents. If you would like to only partially update a document, use /update_where.

If the document with the provided _id doesn't exist, one will be automatically created.
If the provided dataset doesn't exist, one will be automatically created.

Limit the payload of documents to a maximum 100MB for optimal performance.

Path Params

dataset_id

string

required

length ≤ 240

ID of dataset

Body Params

insert_date

boolean

Defaults to true

Whether to include insert date as a field 'insertdate'.

overwrite

boolean

Defaults to true

Whether to overwrite document if it exists.

update_schema

boolean

Defaults to true

Whether the api should check the documents for vector datatype to update the schema.

wait_for_update

boolean

Defaults to true

Whether to return before all documents have finished updating.

field_transformers

array of objects

Before insertion, fields of documents will be transformed according to this array of rules. If transformation fails, the output field will not be generated.

field_transformers

jobs_to_trigger

array of objects

A list of jobs to run once all documents are processed.

jobs_to_trigger

documents

array of objects

documents

Response

Language

Credentials

Header


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://api.us-east-1.relevance.ai/latest/datasets/dataset_id/documents/bulk_insert \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "insert_date": true,
8
  "overwrite": true,
9
  "update_schema": true,
10
  "wait_for_update": true
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200successful operation