ListDocuments

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

Retrieve documents with filters.
Cursor is provided to retrieve even more documents. Loop through it to retrieve all documents in the database.
Filter is used to retrieve documents that match the conditions set in a filter query.

Path Params

dataset_id

string

required

length ≤ 240

ID of dataset

Query Params

select_fields

array of strings

Fields to include in the search results, empty array/list means all fields.

select_fields

page_size

integer

Size of each page of results.

page

integer

Size of each page of results.

sort

array

Fields to sort by. For each field, sort by descending or ascending. If you are using descending by datetime, it will get the most recent ones.

sort

include_vector

boolean

Include vectors in the search results.

filters

array

filters

use_cursor

boolean

Whether to use scroll on the documents. This cannot be used in conjunction with 'page'.

is_random

boolean

(NOT IMPLEMENTED - not functional) If true, retrieves documents randomly. Cannot be used with cursor.

random_state

integer

(NOT IMPLEMENTED - not functional)Random Seed for retrieving random documents.

after_id

array

Retrieve items after these sort values in the sort order.

after_id

Response

Response body

object

cursor

string

count

number

required

documents

array of objects

required

List of documents. List items are affected by page, pageSize, query, filters. Items order is affected by vectorSeachQuery, sort, textSort.

Example: [{"_id":"abcd","animal":"cat","price":10}, {"_id":"abcd","price":13}]

documents*

object

_relevance

number

Measures how closely a document matches on query and vectorSearchQuery.

_chunk_results

object

after_id

array

required

Used in future requests to retrieve items after these values in the sort order.

after_id*

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.us-east-1.relevance.ai/latest/datasets/dataset_id/documents/list \
3
     --header 'accept: application/json'

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

application/json

200successful operation