Index

Index
Index

Index.

JSON Example
{
    "id": "string",
    "name": "string",
    "description": "string",
    "embeddings_model_endpoint": "string",
    "text_splitting": "string",
    "chunk_size": 0,
    "chunk_overlap": 0,
    "hybrid_search": false,
    "text_search_config": "simple",
    "knowledge_base_id": "string",
    "object": "string",
    "created_at": 0,
    "last_indexed_at": 0,
    "last_indexed_by_id": "string",
    "num_documents": 0,
    "status": "string",
    "status_errors": [
        "string"
    ]
}
string As uuid As uuid
id
Required

ID of the index.

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'.

string As uuid As uuid
knowledge_base_id
Required

ID of the knowledge base of the index.

string
object
Optional
Constraints: default: index

Object type, which is always index.

integer
created_at
Required

Unix timestamp (in seconds) when the index was created.

integer
last_indexed_at
Optional

Unix timestamp (in seconds) when the index contents were last indexed.

string As uuid As uuid
last_indexed_by_id
Optional

ID of the most recent indexing job that affected this index.

integer
num_documents
Optional
Constraints: minimum: 0 default: 0

Total number of documents in the index.

IndexStatus
status
Required

Availability status of the index.

Possible values are : AVAILABLE, ERROR,
array of ErrorCode
status_errors
Optional

Details of the index error status, if the index is not available.

Property Of
Returned By