llamaindex · Schema

CreateIndexRequest

Request body for creating a new index.

Properties

Name Type Description
name string Human-readable name for the new index.
project_id string Identifier of the project to create the index in.
embedding_model string Name of the embedding model to use for vectorization.
sync_interval integer Optional scheduled sync frequency in seconds.
View JSON Schema on GitHub

JSON Schema

llamaindex-createindexrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateIndexRequest",
  "title": "CreateIndexRequest",
  "type": "object",
  "description": "Request body for creating a new index.",
  "required": [
    "name",
    "project_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Human-readable name for the new index."
    },
    "project_id": {
      "type": "string",
      "description": "Identifier of the project to create the index in."
    },
    "embedding_model": {
      "type": "string",
      "description": "Name of the embedding model to use for vectorization."
    },
    "sync_interval": {
      "type": "integer",
      "description": "Optional scheduled sync frequency in seconds."
    }
  }
}