Skip to content
Console
On this page

Search indexes

A SearchIndex is one customer lexical and vector index of JSON documents.

A SearchIndex is one customer lexical and vector index of JSON documents. Dimension 0 is lexical only; a positive dimension adds cosine queries. Data never invents embeddings. Silo: each has its own engine, credentials, backup, region, and deletion.

Service Sylphx Data · Resource type data.sylphx.com/SearchIndex · Name pattern orgs/{org}/projects/{project}/envs/{env}/search_indexes/{search_index} · Shape spec_status

Fields

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/search_indexes/{search_index}.
uidstringidx_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specSearchIndexSpecDesired state. Required.
statusSearchIndexStatusObserved state. Output only.

Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

MethodCallWhat it does
GETgetGets a search index.
GETlistLists search indexs in a environment.
POSTcreateCreates a search index. The Operation is done when the controller settles it.
PATCHupdateUpdates a search index.
DELETEdeleteDeletes a search index. Fails while spec.deletion_protection is set.
POSTconnectReturns how to connect to the search index: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here.
POSTrotate_credentialsReplaces the search index's engine credentials; the old ones stop working once the new ones are served.

get

Gets a search index.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index · scope data:read · effect read · Request, response and examples

list

Lists search indexs in a environment.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes · scope data:read · effect read · paginated · Request, response and examples

create

Creates a search index. The Operation is done when the controller settles it.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes · scope data:write · effect write · long-running · Request, response and examples

update

Updates a search index.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index · scope data:write · effect write · long-running · Request, response and examples

delete

Deletes a search index. Fails while spec.deletion_protection is set.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index · scope data:write · effect destructive · long-running · Request, response and examples

connect

Returns how to connect to the search index: its endpoint and its own engine credentials. The credentials are not API keys and are returned only here.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index:connect · scope data:write · effect read · Request, response and examples

rotate_credentials

Replaces the search index's engine credentials; the old ones stop working once the new ones are served.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/search_indexes/search-index:rotateCredentials · scope data:write · effect write · validate_only · long-running · Request, response and examples