POST
/
v1
/
table
/
{name}
/
create_index

Authorizations

x-api-key
string
header
required

Path Parameters

name
string
required

name of the table

Body

application/json
index_type
enum<string>
required

type of index to create

Available options:
IVF_PQ,
IVF_HNSW_SQ,
BTREE,
BITMAP,
LABEL_LIST,
FTS
ascii_folding
boolean
default:
false

Whether to convert non-ASCII characters to ASCII, used for accent folding.

base_tokenizer
string
default:
simple

The base tokenizer to use for full text search.

column
string

The targeted vector column to index. Required only if there are multiple vector columns.

distance_type
enum<string>

distance metric to use for search

Available options:
L2,
Cosine,
Dot
language
string
default:
English

The language to use for stemming and stop words.

lower_case
boolean
default:
false

Whether to convert tokens to lowercase.

max_token_length
integer
default:
40

The maximum token length to index, longer tokens are ignored.

remove_stop_words
boolean
default:
false

Whether to remove stop words from tokens.

stem
boolean
default:
false

Whether to apply stemming to tokens.

with_position
boolean
default:
true

Whether to store the position of tokens in docs, required for phrase search.

Response

200 - application/json

The response is of type object.