Retrieve Document Index | Vellum

Used to retrieve a Document Index given its ID or name.

idstringRequired

Either the Document Index’s ID or its unique name

idstringformat: "uuid"

createddatetime

labelstring<=150 characters

A human-readable label for the document index

namestring<=150 characters

A name that uniquely identifies this index within its workspace

indexing_configobject

statusenumOptional

The current status of the document index

Allowed values:

1	from vellum import Vellum
2
3	client = Vellum(
4	api_key="YOUR_API_KEY",
5	)
6	client.document_indexes.retrieve(
7	id="id",
8	)

1	{
2	"id": "id",
3	"created": "2024-01-15T09:30:00Z",
4	"label": "label",
5	"name": "name",
6	"indexing_config": {
7	"vectorizer": {
8	"model_name": "text-embedding-3-small",
9	"config": {}
10	},
11	"chunking": {
12	"chunker_name": "reducto-chunker"
13	}
14	},
15	"status": "ACTIVE"
16	}