IndexCreateRequest

IndexCreateRequest
IndexCreateRequest

A request to create an index.

JSON Example
{
    "name": "string",
    "description": "string",
    "embeddings_model_endpoint": "string",
    "text_splitting": "string",
    "chunk_size": 0,
    "chunk_overlap": 0,
    "hybrid_search": false,
    "text_search_config": "simple"
}
string
name
Optional
Constraints: maxLength: 256

Name of the index.

string
description
Optional

Description of the index.

string
embeddings_model_endpoint
Required

ID of the model to be used by the index for generating embeddings.

IndexTextSplitting
text_splitting
Required

Method for chunking text for embedding

integer
chunk_size
Required
Constraints: minimum: 100

Maximum size (in tokens) of the text chunks. This must be at least 100 to accommodate for content metadata embedded alongside each chunk of text.

integer
chunk_overlap
Optional
Constraints: minimum: 0 default: 0

Size of the chunk overlap (in tokens) when splitting text.

boolean
hybrid_search
Optional

Enable or disable hybrid search. If enabled, text_search_config must be provided.

string
text_search_config
Optional

The text search configuration to use for hybrid search. The available values depend on the version of the database server used by this Private AI Services instances. Please refer to the PostgreSQL server documentation for available values. For example: 'simple', 'english', 'french'.

Parameter To