Typesense

https://typesense.org/docs
Admin
Typesense is an open-source, fast, typo-tolerant search engine designed for building great search...
Tokens:624,133
Snippets:3,696
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install and start Typesense on Windows (WSL)

Source: https://typesense.org/docs/guide/install-typesense.md

Installs the Typesense server on Windows Subsystem for Linux (WSL) using the .deb package, then starts it with the configuration file. The post-install error message can be safely ignored.

```bash
wsl
curl -O https://dl.typesense.org/releases/{{ $site.themeConfig.typesenseLatestVersion }}/typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-amd64.deb
sudo apt install ./typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-amd64.deb
<br>
# Start Typesense
sudo /usr/bin/./typesense-server --config=/etc/typesense/typesense-server.ini
```

--------------------------------

### Homebrew: Install and start Typesense

Source: https://typesense.org/docs/guide/install-typesense.md

Installs Typesense via Homebrew and starts the service. The version placeholder is replaced by the latest version.

```bash
brew install typesense/tap/typesense-server@{{ $site.themeConfig.typesenseLatestVersion }}
brew services start typesense-server@{{ $site.themeConfig.typesenseLatestVersion }}
```

--------------------------------

### Install and import Typesense Go client

Source: https://typesense.org/docs/30.2/api/api-clients.md

Shows how to get the Go client module and import the required packages.

```go
// $ go get github.com/typesense/typesense-go/v3/typesense

import (
  "github.com/typesense/typesense-go/v3/typesense"
  "github.com/typesense/typesense-go/v3/typesense/api"
  "github.com/typesense/typesense-go/v3/typesense/api/pointer"
)
```

--------------------------------

### Install Typesense on Debian/Ubuntu (DEB package)

Source: https://typesense.org/docs/guide/install-typesense.md

Download and install the Typesense server DEB package, then start the service. The config file is at /etc/typesense/typesense-server.ini, with the admin API key auto-generated inside it. Logs are under /var/log/typesense/ and data under /var/lib/typesense/.

```bash
# Download & Install
curl -O https://dl.typesense.org/releases/{{ $site.themeConfig.typesenseLatestVersion }}/typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-linux-amd64.deb
sudo apt install ./typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-linux-amd64.deb
<br>
# Start Typesense
sudo systemctl start typesense-server.service
```

--------------------------------

### Project structure after initial setup

Source: https://typesense.org/docs/guide/next-js-search-bar.md

Shows the initial project structure after creating a Next.js app and installing dependencies.

```text
typesense-next-search-bar/
├── node_modules/
├── pages/
│   └── index.tsx
├── public/
│   ├── file.svg
│   ├── globe.svg
│   ├── next.svg
│   ├── vercel.svg
│   └── window.svg
├── .eslintrc.json
├── .gitignore
├── next-env.d.ts
├── next.config.ts
├── package-lock.json
├── package.json
└── tsconfig.json
```

--------------------------------

### Start Typesense server with --config flag

Source: https://typesense.org/docs/30.2/api/server-configuration.md

Starts the Typesense server using a configuration file. The configuration file path is specified with the --config flag. The Linux DEB/RPM packages install the configuration file at /etc/typesense/typesense-server.ini.

```bash
./typesense-server --config=/etc/typesense/typesense-server.ini
```

--------------------------------

### Project structure after initial setup

Source: https://typesense.org/docs/guide/sveltekit-search-bar.md

Shows the expected directory layout after creating a basic SvelteKit app and installing dependencies.

```plaintext
typesense-sveltekit-search-app/
├── src/
│   ├── lib/
│   ├── routes/
│   │   ├── +layout.svelte
│   │   └── +page.svelte
│   ├── app.d.ts
│   └── app.html
├── static/
├── package.json
├── svelte.config.js
├── tsconfig.json
└── vite.config.ts
```

--------------------------------

### Set Typesense environment variables and start server

Source: https://typesense.org/docs/30.2/api/server-configuration.md

Use environment variables prefixed with TYPESENSE_ to configure the server. The example sets TYPESENSE_DATA_DIR and TYPESENSE_API_KEY before running the typesense-server binary.

```bash
TYPESENSE_DATA_DIR=/var/lib/typesense TYPESENSE_API_KEY=AS3das2awQ2 ./typesense-server
```

--------------------------------

### Run the Go server

Source: https://typesense.org/docs/guide/gin-search-api.md

Starts the Go server. The expected startup output shows Typesense client creation, collection initialization, and GIN debug routes.

```bash
go run server.go
```

--------------------------------

### Initialize Django project and install dependencies

Source: https://typesense.org/docs/guide/django-search-api.md

Creates a virtual environment, installs Django, Typesense client, psycopg2, python-dotenv, and apscheduler, then creates a Django project and a 'books' app.

```bash
mkdir typesense-django-full-text-search
cd typesense-django-full-text-search
python -m venv .venv
source .venv/bin/activate
pip install django typesense psycopg2-binary python-dotenv apscheduler

django-admin startproject typesensedjango .
python manage.py startapp books
```

--------------------------------

### Install docusaurus-theme-search-typesense

Source: https://typesense.org/docs/guide/docsearch.md

Install the docusaurus-theme-search-typesense plugin using npm, yarn, or pnpm. The example shows all three package managers.

```shellsession
$ npm install docusaurus-theme-search-typesense@next --save

# or

$ yarn add docusaurus-theme-search-typesense@next

# or

$ pnpm add docusaurus-theme-search-typesense@next
```

--------------------------------

### Navigate to project directory and install dependencies

Source: https://typesense.org/docs/guide/sveltekit-search-bar.md

After scaffolding, navigate into the project directory and install the required dependencies: typesense, typesense-instantsearch-adapter, and instantsearch.js.

```shell
cd typesense-sveltekit-search-app
npm install
npm i typesense typesense-instantsearch-adapter instantsearch.js
```

--------------------------------

### Example response for get single configuration change

Source: https://typesense.org/docs/cloud-management-api/v1/cluster-configuration-changes.md

Example JSON response from the get single configuration change endpoint. It includes the configuration change ID, status, timestamps, and old/new values for memory, vCPU, high availability, and other settings.

```json
{
  "id": "ecf1d570-7f49-47ef-b648-41ccf7eaf5d2",
  "status": "pending",
  "created_at": 1687996347,
  "updated_at": 1687996347,
  "perform_change_at": 1787923647,
  "completed_at": null,
  "old_memory": "0.5_gb",
  "old_vcpu": "2_vcpus_1_hr_burst_per_day",
  "old_gpu": null,
  "old_high_performance_disk": null,
  "old_typesense_server_version": "0.23.1",
  "old_high_availability": "no",
  "old_high_availability_node_count": null,
  "old_search_delivery_network": "off",
  "old_load_balancing": "no",
  "old_region_node_counts": {
    "oregon": 1
  },
  "new_memory": "1_gb",
  "new_vcpu": "2_vcpus_2_hr_burst_per_day",
  "new_gpu": null,
  "new_high_performance_disk": null,
  "new_typesense_server_version": "0.24.1",
  "new_high_availability": "yes",
  "new_high_availability_node_count": 3,
  "new_search_delivery_network": "off",
  "new_load_balancing": "yes",
  "new_region_node_counts": {
    "oregon": 3
  },
  "notification_email_addresses": [
    "email@example.com"
  ]
}
```

--------------------------------

### Initialize Go project and install dependencies

Source: https://typesense.org/docs/guide/gin-search-api.md

Commands to create a new Go module and install Gin, CORS middleware, Typesense Go client, godotenv, GORM, and the PostgreSQL driver.

```bash
mkdir typesense-gin-full-text-search
cd typesense-gin-full-text-search
go mod init github.com/<yourusername>/typesense-gin-full-text-search

go get github.com/gin-gonic/gin
go get github.com/gin-contrib/cors
go get github.com/typesense/typesense-go/v4
go get github.com/joho/godotenv
go get gorm.io/gorm
go get gorm.io/driver/postgres
```

--------------------------------

### Install Typesense on Ubuntu/Debian (arm64)

Source: https://typesense.org/docs/guide/install-typesense.md

Download and install the Typesense DEB package for arm64, then start the Typesense service using systemd.

```bash
# Download & Install
curl -O https://dl.typesense.org/releases/{{ $site.themeConfig.typesenseLatestVersion }}/typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-arm64.deb
sudo apt install ./typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-arm64.deb
<br>
# Start Typesense
sudo systemctl start typesense-server.service
```

--------------------------------

### Install Typesense on Ubuntu/Debian (amd64)

Source: https://typesense.org/docs/guide/install-typesense.md

Download and install the Typesense DEB package for amd64, then start the Typesense service using systemd.

```bash
# Download & Install
curl -O https://dl.typesense.org/releases/{{ $site.themeConfig.typesenseLatestVersion }}/typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-amd64.deb
sudo apt install ./typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-amd64.deb
<br>
# Start Typesense
sudo systemctl start typesense-server.service
```

--------------------------------

### Validation error response example

Source: https://typesense.org/docs/cloud-management-api/v1/typesense-server-configuration-parameters.md

Example error response returned when a validation error occurs, such as when the parameter value does not start with https://.

```json
{
  "success": false,
  "message": "Parameter value must start with https://"
}
```

--------------------------------

### Navigate to project and install dependencies

Source: https://typesense.org/docs/guide/react-native-search-bar.md

After scaffolding, navigate into the project directory and install the required npm packages: react-instantsearch-core for InstantSearch hooks and typesense-instantsearch-adapter to connect Typesense.

```shell
cd typesense-react-native-search-bar
npm install
npm i react-instantsearch-core typesense-instantsearch-adapter
```

--------------------------------

### Get Single Cluster - Response

Source: https://typesense.org/docs/cloud-management-api/v1/cluster-management.md

Example JSON response from the get single cluster endpoint. Contains cluster configuration, status, and usage details.

```json
{
  "id": "nuj9s7k6vplrg15yp",
  "name": null,
  "memory": "0.5_gb",
  "vcpu": "2_vcpus_1_hr_burst_per_day",
  "gpu": "no",
  "high_performance_disk": "no",
  "typesense_server_version": "0.23.1",
  "high_availability": "yes",
  "high_availability_node_count": 3,
  "search_delivery_network": "off",
  "load_balancing": "yes",
  "regions": [
    "mumbai",
    "mumbai",
    "mumbai"
  ],
  "region_node_counts": {
    "mumbai": 3
  },
  "auto_upgrade_capacity": null,
  "hostnames": {
    "load_balanced": "nuj9s7k6vplrg15yp.a1.typesense.net",
    "nodes": [
      "nuj9s7k6vplrg15yp-1.a1.typesense.net",
      "nuj9s7k6vplrg15yp-2.a1.typesense.net",
      "nuj9s7k6vplrg15yp-3.a1.typesense.net"
    ]
  },
  "usage": {
    "runtime_hours": 1,
    "used_bandwidth_kb": {
      "last_7_days": {}
    }
  },
  "provisioned_by": {
    "user_name": "API Key: sc4DyvAzf*****",
    "user_type": "API Key"
  },
  "provisioned_at": 1663616196,
  "status": "in_service"
}
```

--------------------------------

### Get a single parameter - JSON response

Source: https://typesense.org/docs/cloud-management-api/v1/typesense-server-configuration-parameters.md

Example response from the GET endpoint, showing the parameter details including id, parameter_name, parameter_value, and timestamps.

```json
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "parameter_name": "cors-domains",
  "parameter_value": "https://example.com,https://app.example.com",
  "created_at": "2025-06-14T12:00:00Z",
  "updated_at": "2025-06-14T12:00:00Z"
}
```

--------------------------------

### Install Typesense and InstantSearch dependencies

Source: https://typesense.org/docs/guide/qwik-js-search-bar.md

Navigates into the project directory and installs the required dependencies: typesense, typesense-instantsearch-adapter, instantsearch.js, and instantsearch.css.

```shell
cd typesense-qwik-search
npm i typesense typesense-instantsearch-adapter instantsearch.js instantsearch.css
```

--------------------------------

### Initialize Python project and install dependencies

Source: https://typesense.org/docs/guide/langchain-ai-search.md

Creates a project directory, sets up a Python virtual environment, and installs the required dependencies: chainlit, langchain, langchain-openai, typesense, python-dotenv, and requests.

```bash
mkdir typesense-langchain-ai-search
cd typesense-langchain-ai-search
python3 -m venv .venv
source .venv/bin/activate

pip install chainlit langchain langchain-openai typesense python-dotenv requests
```

--------------------------------

### Install Typesense client with npm

Source: https://typesense.org/docs/guide/natural-language-search.md

Installs the Typesense JavaScript client library into the Next.js app. The @next tag is used to get the latest version.

```shell
npm i typesense@next
```

--------------------------------

### Enable and install Ceymox_TypesenseSearch Magento module

Source: https://typesense.org/docs/guide/magento2-search.md

Run these commands from the Magento root directory after installing the extension. They enable the module, upgrade the setup, compile the code, deploy static content, and clean the cache.

```shell
php bin/magento module:enable Ceymox_TypesenseSearch - to enable extension.

php bin/magento setup:upgrade - to install the extension.

php bin/magento setup:di:compile - to compile the code.

php bin/magento setup:static-content:deploy - to deploy static view files.

php bin/magento cache:clean - to clean the cache.
```

--------------------------------

### Initialize Deno project and add dependencies

Source: https://typesense.org/docs/guide/deno-hono-search-api.md

Creates the project directory and adds Hono, postgres, and typesense dependencies using Deno's add command.

```bash
mkdir typesense-deno-hono-search-app
cd typesense-deno-hono-search-app

deno add jsr:@hono/hono npm:postgres npm:typesense
```

--------------------------------

### Create lib directory and adapter file

Source: https://typesense.org/docs/guide/angular-search-bar.md

Creates the lib directory and the instantsearch-adapter.ts file.

```bash
mkdir -p src/app/lib
touch src/app/lib/instantsearch-adapter.ts

```

--------------------------------

### Project structure after initial setup

Source: https://typesense.org/docs/guide/vanilla-js-search-bar.md

Shows the directory structure after creating a Vite app and installing dependencies.

```plaintext
typesense-vanilla-js-search/
├── node_modules/
├── public/
│   └── vite.svg
├── src/
│   ├── main.js
│   └── style.css
├── .gitignore
├── index.html
├── package-lock.json
└── package.json
```

--------------------------------

### Response: list of configuration parameters

Source: https://typesense.org/docs/cloud-management-api/v1/typesense-server-configuration-parameters.md

Example JSON response showing the list of configuration parameters. Each object includes the parameter name, value, and timestamps.

```json
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "parameter_name": "cors-domains",
    "parameter_value": "https://example.com,https://app.example.com",
    "created_at": "2025-06-14T12:00:00Z",
    "updated_at": "2025-06-14T12:00:00Z"
  },
  {
    "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "parameter_name": "max-per-page",
    "parameter_value": "500",
    "created_at": "2025-06-14T12:00:00Z",
    "updated_at": "2025-06-14T12:00:00Z"
  }
]
```

--------------------------------

### Install search dependencies

Source: https://typesense.org/docs/guide/angular-search-bar.md

Navigates into the project directory and installs the search dependencies: typesense, typesense-instantsearch-adapter, and instantsearch.js.

```shell
cd typesense-angular-search-bar
npm i typesense typesense-instantsearch-adapter instantsearch.js
```

--------------------------------

### Create components directory and files

Source: https://typesense.org/docs/guide/solid-js-search-bar.md

Commands to create the components directory and files for BookSearch, BookList, and BookCard, followed by the resulting project structure.

```bash
mkdir -p src/components
touch src/components/BookSearch.tsx src/components/BookSearch.module.css
touch src/components/BookList.tsx src/components/BookList.module.css
touch src/components/BookCard.tsx src/components/BookCard.module.css
```

```plaintext
typesense-solid-js-search/
├── public/
│   └── favicon.svg
├── src/
│   ├── components/
│   │   ├── BookCard.tsx
│   │   ├── BookCard.module.css
│   │   ├── BookList.tsx
│   │   ├── BookList.module.css
│   │   ├── BookSearch.tsx
│   │   ├── BookSearch.module.css
│   ├── utils/
│   │   └── typesense.ts
│   ├── App.tsx
│   ├── index.css
│   └── index.tsx
├── .gitignore
├── index.html
├── package-lock.json
├── package.json
├── tsconfig.app.json
├── tsconfig.json
└── vite.config.ts
```

--------------------------------

### Create project directory structure

Source: https://typesense.org/docs/guide/django-search-api.md

Run these shell commands to create the required directories and files for the books search app and the .env file.

```bash
mkdir -p books/search
touch books/search/__init__.py books/search/client.py books/search/collections.py 
touch books/search/sync.py books/search/worker.py
touch .env
```

--------------------------------

### Example paginated sync log output

Source: https://typesense.org/docs/guide/node-sequelize-search-api.md

Example output from a sync operation processing 10,000 records in batches of 1,000. It shows the sync start time and the first two batch imports, with an ellipsis indicating the remaining batches.

```plaintext
Starting sync since 2026-02-25T11:30:39.000Z
Imported batch 1 (1000 books)
Imported batch 2 (1000 books)
...
Imported batch 10 (1000 books)
```

--------------------------------

### Start the backend server

Source: https://typesense.org/docs/guide/node-drizzle-search-api.md

Run this command in the terminal to start the backend application. The expected output is 'Server listening on port 3000'.

```bash
npm run dev
```

```plaintext
Server listening on port 3000
```

--------------------------------

### Create component files and view updated structure

Source: https://typesense.org/docs/guide/qwik-js-search-bar.md

Create the component files BookCard.tsx, BookList.tsx, and Heading.tsx, then view the updated project structure.

```bash
touch src/components/BookCard.tsx
touch src/components/BookList.tsx
touch src/components/Heading.tsx
```

```plaintext
typesense-qwik-search/
├── src/
│   ├── components/
│   │   ├── router-head/
│   │   ├── BookCard.tsx
│   │   ├── BookList.tsx
│   │   └── Heading.tsx
│   ├── routes/
│   │   └── index.tsx
│   ├── types/
│   │   └── Book.ts
│   ├── utils/
│   │   └── typesense.ts
│   ├── entry.dev.tsx
│   ├── entry.preview.tsx
│   ├── entry.ssr.tsx
│   ├── global.css
│   └── root.tsx
├── .env
├── .gitignore
├── package.json
├── tsconfig.json
└── vite.config.ts
```

--------------------------------

### GET /collections/{collection_name}/documents/search

Source: https://typesense.org/docs/30.2/api/search.md

This snippet documents the search endpoint with decay function sorting, including the syntax, parameters, and an example.

```APIDOC
## [GET] /collections/{collection_name}/documents/search

### Description
Search documents in a collection with decay function sorting to score and sort results based on distance from a target value.

### Method
GET

### Endpoint
/collections/{collection_name}/documents/search

### Parameters
#### Query Parameters
- **q** (string) - Required - The search query.
- **query_by** (string) - Required - The field to search against.
- **sort_by** (string) - Required - Sorting specification with decay function syntax: `field_name(origin: value, func: function_name, scale: value, decay: rate):direction`

#### Decay Function Parameters (within sort_by)
- **origin** (integer) - Required - The reference point from which the decay function is calculated.
- **func** (string) - Required - The decay function to use. Supported values: `gauss`, `linear`, `exp`, or `diff`.
- **scale** (integer) - Required - The distance from origin at which the score should decay by the decay rate. Must be a non-zero integer.
- **offset** (integer) - Optional - An offset to apply to the origin point. Defaults to 0.
- **decay** (float) - Optional - The rate at which scores decay, between 0.0 and 1.0. Defaults to 0.5.

### Request Example
```bash
curl -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
"http://localhost:8108/collections/products/documents/search\
?q=smartphone\
&query_by=product_name\
&sort_by=timestamp(origin: 1728385250, func: gauss, scale: 1000, decay: 0.5):desc"
```

### Response
#### Success Response (200)
- **hits** (array) - The search results, ordered by decay function score.
- **found** (integer) - The total number of matching documents.

#### Response Example
```json
{
  "hits": [
    {"product_name": "Oneplus Smartphone", "timestamp": 1728385250},
    {"product_name": "Pixel Smartphone", "timestamp": 1728386250},
    {"product_name": "Vivo Smartphone", "timestamp": 1728384250},
    {"product_name": "Moto Smartphone", "timestamp": 1728387250},
    {"product_name": "Samsung Smartphone", "timestamp": 1728383250}
  ],
  "found": 5
}
```
```

--------------------------------

### Install typesense-instantsearch-adapter

Source: https://typesense.org/docs/guide/search-ui-components.md

Install the Typesense InstantSearch adapter via npm to enable InstantSearch to use a Typesense backend.

```bash
$ npm install --save typesense-instantsearch-adapter
```

--------------------------------

### Install Typesense on CentOS/RHEL (RPM package, aarch64)

Source: https://typesense.org/docs/guide/install-typesense.md

Download and install the Typesense server RPM package for aarch64 architecture, then start the service. The config file is at /etc/typesense/typesense-server.ini, with the admin API key auto-generated inside it. Logs are under /var/log/typesense/ and data under /var/lib/typesense/.

```bash
# Download & Install
curl -O https://dl.typesense.org/releases/{{ $site.themeConfig.typesenseLatestVersion }}/typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-1.aarch64.rpm
sudo yum install ./typesense-server-{{ $site.themeConfig.typesenseLatestVersion }}-1.aarch64.rpm
<br>
# Start Typesense
sudo systemctl start typesense-server.service
```

--------------------------------

### Run migrations and start server

Source: https://typesense.org/docs/guide/django-search-api.md

Runs database migrations and starts the development server on port 8000.

```bash
python manage.py makemigrations
python manage.py migrate
python manage.py runserver 8000
```
Tokens:
Raw