Insert

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

When inserting the document you can specify your own id for a document by using the field name "_id".

For specifying your own vector use the suffix (ends with)  **"\_vector\_"** for the field name.

e.g. "product_description_vector_"

If inserting many items in a short timespan, use bulkInsert, or set update_schema to false. 
Every insert api call temporarily locks and updates the schema, so will slow down with many inserts in quick succession.

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

document

object

Each document to upsert must have an _id field matching an existing document.

Response

Language

Credentials

Header


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://api.us-east-1.relevance.ai/latest/datasets/dataset_id/documents/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!

200successful operation