Typesense

https://typesense.org/docs/29.0/api/
Admin
Typesense is an open-source search engine that provides fast, typo-tolerant search with support for...
Tokens:219,648
Snippets:1,516
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install and import Typesense Go client

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

Install the Typesense Go client with go get 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"
)
```

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

### Set Typesense environment variables and start server

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

Use environment variables to configure the Typesense server. Variables are prefixed with TYPESENSE_ and use uppercase with underscores instead of hyphens. This example sets the data directory and API key before starting the server.

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

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

### Example Typesense server configuration file (INI format)

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

Configuration file in INI format. Parameters from the tables can be used without the preceding '--'. The file is typically installed at /etc/typesense/typesense-server.ini by Linux DEB/RPM packages.

```ini
; /etc/typesense/typesense-server.ini

[server]

api-key = Rhsdhas2asasdasj2
data-dir = /var/lib/typesense
log-dir = /var/log/typesense
api-port = 9090
```

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

### Example JSONL file for import

Source: https://typesense.org/docs/29.0/api/documents.html

A sample JSONL file with two documents, each containing fields like id, company_name, num_employees, and country. This file is used as input for the import examples.

```jsonl
{"id": "1", "company_name": "Stark Industries", "num_employees": 5215, "country": "USA"}
{"id": "2", "company_name": "Orbit Inc.", "num_employees": 256, "country": "UK"}

```

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

### Install Typesense Ruby client with gem

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

Install the Typesense Ruby client library using RubyGems.

```shell
gem install typesense
```

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

### Example records for bucket_size demonstration

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

Example records used to illustrate the bucket_size parameter. Searching for "mark" against these records with bucket_size: 3 groups results into buckets of 3 records based on text match scores, then sorts by points descending within each bucket.

```json
[
  {"title": "Mark Antony", "points": 100},
  {"title": "Marks Spencer", "points": 200},
  {"title": "Mark Twain", "points": 100},
  {"title": "Mark Payne", "points": 300},
  {"title": "Marks Henry", "points": 200},
  {"title": "Mark Aurelius", "points": 200}
]
```

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

### Install Typesense Python client with pip

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

Install the Typesense Python client library using pip.

```shell
pip install typesense
```

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

### Install Typesense JavaScript client

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

Install the Typesense JavaScript client via npm and include the browser bundle with a script tag. The npm install command installs both typesense and @babel/runtime.

```html
// npm install typesense @babel/runtime

// Browser
<script src="dist/typesense.min.js"></script>
```

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

### Install Typesense PHP client with Composer

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

Install the Typesense PHP client library using Composer. Requires the php-http/curl-client package.

```shell
composer require php-http/curl-client typesense/typesense-php
```

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

### Sample Response for retrieve override

Source: https://typesense.org/docs/29.0/api/curation.html

Example JSON response returned when retrieving the override 'customize-apple'.

```JSON
{
  "id":"customize-apple",
  "excludes":[
    {
      "id":"287"
    }
  ],
  "includes":[
    {
      "id":"422",
      "position":1
    },
    {
      "id":"54",
      "position":2
    }
  ],
  "rule":{
    "match":"exact",
    "query":"apple"
  }
}
```

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

### Sample books documents

Source: https://typesense.org/docs/29.0/api/joins.html

Example book documents used to illustrate one-to-many join behavior.

```json
{"title": "Famous Five", "author_id": "0"}
{"title": "Secret Seven", "author_id": "0"}
{"title": "Harry Potter", "author_id": "1"}
```

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

### Example natural language queries

Source: https://typesense.org/docs/29.0/api/natural-language-search.html

A list of example natural language queries that users might type into the search bar, demonstrating the variety of intents the feature can handle.

```text
- A honda or BMW with at least 200hp, rear-wheel drive, from 20K to 50K
- Show me the most powerful car you have
- High performance Italian cars, above 700hp
- I don't know how to drive a manual
```

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

### Shell: Set API key and host, then curl search with header or GET parameter

Source: https://typesense.org/docs/29.0/api/authentication.html

Shows how to set environment variables for the API key and host, then perform a search request with curl passing the API key either via the X-TYPESENSE-API-KEY header or as a GET parameter. Includes commented values for Typesense Cloud.

```shell
export TYPESENSE_API_KEY='<API_KEY>'
export TYPESENSE_HOST='http://localhost:8108'

# For Typesense Cloud use:
# export TYPESENSE_HOST='https://xxx.a1.typesense.net'

# a) Passing API key via header

curl -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
"http://localhost:8108/collections/companies/documents/search\
?q=stark&query_by=company_name&filter_by=num_employees:>100\
&sort_by=num_employees:desc"

# b) Passing API key via GET parameter

curl "http://localhost:8108/collections/companies/documents/search\
?q=stark&query_by=company_name&filter_by=num_employees:>100\
&sort_by=num_employees:desc&x-typesense-api-key=${TYPESENSE_API_KEY}"
```

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

### Install and import Typesense Dart client

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

Install the Typesense Dart client for Dart or Flutter projects and import it. The pub add commands add the dependency to pubspec.yaml.

```dart
// With Dart:
//  $ dart pub add typesense

// With Flutter:
//  $ flutter pub add typesense

// This will add a line like this to your package's pubspec.yaml:
// dependencies:
//   typesense: ^0.3.0

// Now in your Dart code, you can use:

import 'package:typesense/typesense.dart';
```

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

### Sample authors documents

Source: https://typesense.org/docs/29.0/api/joins.html

Example author documents used to illustrate one-to-many join behavior.

```json
{"id": "0", ",first_name": "Enid", "last_name": "Blyton"}
{"id": "1", ",first_name": "JK", "last_name": "Rowling"}
```

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

### Sample Response for Delete by Query

Source: https://typesense.org/docs/29.0/api/documents.html

Example JSON response showing the number of documents deleted.

```JSON
{
  "num_deleted": 24
}

```

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

### Start a conversation with curl using multi_search

Source: https://typesense.org/docs/29.0/api/conversational-search-rag.html

Use this curl command to start a conversation with Typesense. It sends a POST request to the multi_search endpoint with conversation=true and conversation_model_id=conv-model-1, and includes a search on the tv_shows collection. Remember to set the q parameter as a query parameter, not in the body, and to exclude the embedding field to avoid sending raw floating point numbers to the LLM.

```bash
curl 'http://localhost:8108/multi_search?q=can+you+suggest+an+action+series&conversation=true&conversation_model_id=conv-model-1' \
        -X POST \
        -H "Content-Type: application/json" \
        -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
        -d '{
              "searches": [
                {
                  "collection": "tv_shows",
                  "query_by": "embedding",
                  "exclude_fields": "embedding"
                }
              ]
            }'
```

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

### Sample response for cluster metrics

Source: https://typesense.org/docs/29.0/api/cluster-operations.html

Example JSON response from the metrics endpoint, showing system and Typesense memory metrics.

```json
{
  "system_cpu1_active_percentage": "0.00",
  "system_cpu2_active_percentage": "0.00",
  "system_cpu3_active_percentage": "0.00",
  "system_cpu4_active_percentage": "0.00",
  "system_cpu_active_percentage": "0.00",
  "system_disk_total_bytes": "1043447808",
  "system_disk_used_bytes": "561152",
  "system_memory_total_bytes": "2086899712",
  "system_memory_used_bytes": "1004507136",
  "system_memory_total_swap_bytes": "1004507136",
  "system_memory_used_swap_bytes": "0.00",
  "system_network_received_bytes": "1466",
  "system_network_sent_bytes": "182",
  "typesense_memory_active_bytes": "29630464",
  "typesense_memory_allocated_bytes": "27886840",
  "typesense_memory_fragmentation_ratio": "0.06",
  "typesense_memory_mapped_bytes": "69701632",
  "typesense_memory_metadata_bytes": "4588768",
  "typesense_memory_resident_bytes": "29630464",
  "typesense_memory_retained_bytes": "25718784"
}
```

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

### Start Typesense server with a configuration file

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

Use the --config flag to specify the path to a configuration file. Command-line arguments take precedence over configuration file settings.

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

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

### Key with regex collection pattern

Source: https://typesense.org/docs/29.0/api/api-keys.html

Example key definition using a regular expression to match multiple collections starting with 'org_'.

```json
{
  "description": "Key for searching org collections.",
  "actions": [
    "documents:search"
  ],
  "collections": [
    "org_.*"
  ]
}

```

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

### Sample response for key creation

Source: https://typesense.org/docs/29.0/api/api-keys.html

Example JSON response returned when creating a key, showing an admin key with wildcard actions and collections.

```json
{
  "actions": [
    "*"
  ],
  "collections": [
    "*"
  ],
  "description": "Admin key.",
  "expires_at": 64723363199,
  "id": 1,
  "value": "k8pX5hD0793d8YQC5aD1aEPd7VleSuGP"
}

```

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

### Sample Response for List All Keys

Source: https://typesense.org/docs/29.0/api/api-keys.html

Sample response for listing all keys. Each key returns metadata including actions, collections, description, expiration, ID, and value_prefix. Only the key prefix is returned for security; the full key is only available from the create endpoint.

```JSON
{
  "keys": [
    {
      "actions": [
        "documents:search"
      ],
      "collections": [
        "users"
      ],
      "description": "Search-only key.",
      "expires_at": 64723363199,
      "id": 1,
      "value_prefix": "iKBT"
    },
    {
      "actions": [
        "documents:search"
      ],
      "collections": [
        "users"
      ],
      "description": "Search-only key.",
      "expires_at": 64723363199,
      "id": 2,
      "value_prefix": "wst8"
    }
  ]
}

```

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

### Add metadata to collection schema

Source: https://typesense.org/docs/29.0/api/collections.md

Example JSON for creating a collection with a 'metadata' object. The metadata fields are persisted and returned by the GET /collections endpoint.

```json
{
  "name": "docs",
  "enable_nested_fields": true,
  "fields": [
    {
      "name": "title",
      "type": "string",
      "facet": true
    }
  ],
  "metadata": {
    "batch_job": 325,
    "indexed_from": "2023-04-20T00:00:00.000Z"
  }
}
```

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

### Export documents in JSONL format

Source: https://typesense.org/docs/29.0/api/documents.html

Export documents from the 'companies' collection in JSONL format using the official client libraries or a raw HTTP request. The Java example shows setting the include_fields parameter to restrict exported fields. The Shell example uses the X-TYPESENSE-API-KEY header and the GET method against the export endpoint.

```javascript
client.collections('companies').documents().export()
```

```php
$client->collections['companies']->documents->export();
```

```python
client.collections['companies'].documents.export()
```

```ruby
client.collections['companies'].documents.export
```

```dart
await client.collection('companies').documents.exportJSONL();
```

```java
ExportDocumentsParameters exportDocumentsParameters = new ExportDocumentsParameters();
exportDocumentsParameters.setIncludeFields("id,publication_year,authors");
client.collections("companies").documents().export(exportDocumentsParameters);
```

```go
client.Collection("companies").Documents().Export(context.Background(), &api.ExportDocumentsParams{})
```

```swift
let (data, response) = try await client.collection(name: "companies").documents().export()
```

```shell
curl -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" -X GET \
    "http://localhost:8108/collections/companies/documents/export"
```

```text
Typesense has a RESTful HTTP API.
So you can use any HTTP library in your language of choice to make API calls to it.
The official client libraries are just thin wrappers around the API, with a retry mechanism.
Have a look at the "Shell" tab for guidance on HTTP headers, method and parameters to use to make HTTP calls.
```

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

### List all synonyms in Go

Source: https://typesense.org/docs/29.0/api/synonyms.md

Lists all synonyms for the 'products' collection using the Go client.

```go
client.Collection("products").Synonyms().Retrieve(context.Background())
```

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

### List all collections (all languages)

Source: https://typesense.org/docs/29.0/api/collections.md

Returns a summary of all collections, sorted by creation date with most recent first. Supports pagination with offset and limit, and can exclude field definitions with exclude_fields=fields. The cURL example uses the endpoint GET /collections.

```javascript
client.collections().retrieve()
```

```php
$client->collections->retrieve();
```

```python
client.collections.retrieve()
```

```ruby
client.collections.retrieve
```

```dart
await client.collections.retrieve();
```

```java
CollectionResponse[] collectionResponses = client.collections().retrieve();
```

```go
client.Collections().Retrieve(context.Background())
```

```swift
let (collections, response) = try await client.collections().retrieveAll()
// collections is of type [CollectionResponse]
```

```bash
curl -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
    "http://localhost:8108/collections"
```

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

### Retrieve a collection by name (all languages)

Source: https://typesense.org/docs/29.0/api/collections.md

Retrieves the details of a collection given its name. The collection name is 'companies'. The cURL example uses the X-TYPESENSE-API-KEY header and the endpoint GET /collections/companies. The sample response shows the collection's fields and default_sorting_field.

```javascript
client.collections('companies').retrieve()
```

```php
$client->collections['companies']->retrieve();
```

```python
client.collections['companies'].retrieve()
```

```ruby
client.collections['companies'].retrieve
```

```dart
await client.collection('companies').retrieve();
```

```java
CollectionResponse collection = client.collections("companies").retrieve();
```

```go
client.Collection("companies").Retrieve(context.Background())
```

```swift
let (collectionResponse, response) = try await client.collection(name: "companies").retrieve()
```

```bash
curl -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
     -X GET \
    "http://localhost:8108/collections/companies"
```

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

### Upsert a search preset (listing_view) in multiple languages

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

Create a search preset named `listing_view` that performs a wildcard search on the `products` collection sorted by `popularity`. The preset stores search parameters under the `value` key; the Go example uses `PresetUpsertSchema` and `FromMultiSearchSearchesParameter`.

```js
  await client.presets().upsert("listing_view", {
    value: {
      collection: "products", q: "*", sort_by: "popularity",
    },
  });
```

```dart
  await client.presets.upsert('listing_view', {
    'value': {
      'collection': 'products', 'q': '*','sort_by': 'popularity'
    }
  });
```

```go
preset := &api.PresetUpsertSchema{}
preset.Value.FromMultiSearchSearchesParameter(api.MultiSearchSearchesParameter{
  Searches: []api.MultiSearchCollectionParameters{
    {
      Collection: pointer.Any("products"),
      Q:          pointer.Any("*"),
      SortBy:     pointer.Any("popularity"),
    },
  },
})

client.Presets().Upsert(context.Background(), "listing-view", preset)
```

```shell
curl "http://localhost:8108/presets/listing_view" -X PUT \
    -H "Content-Type: application/json" \
    -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
    -d '{
          "value": {
            "collection": "products",
            "q": "*",
            "sort_by": "popularity"
          }
        }'
```

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

### List all synonyms in Swift

Source: https://typesense.org/docs/29.0/api/synonyms.md

Lists all synonyms for the 'products' collection using the Swift client.

```swift
let (searchSynonyms, response) = try await client.collection(name: "products").synonyms().retrieve()
```

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

### Create Admin Key (Go)

Source: https://typesense.org/docs/29.0/api/api-keys.html

Creates an admin key with wildcard actions and collections. The key is only returned during creation.

```Go
key, err := client.Keys().Create(context.Background(), &api.ApiKeySchema{
  Description: "Admin key.",
  Actions:     []string{"*"},
  Collections: []string{"*"},
})

```

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

### Pivot sort example results

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

Example output showing the order of timestamps when sorting ascending relative to origin 1728386250 with the diff function.

```text
timestamp: 1728386250 (exact match to origin)
timestamp: 1728387250 (1000 away from origin)
timestamp: 1728385250 (1000 away from origin)
timestamp: 1728384250 (2000 away from origin)
timestamp: 1728383250 (3000 away from origin)
```

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

### Get Model Details with curl

Source: https://typesense.org/docs/29.0/api/natural-language-search.html

Sends a GET request to /nl_search_models/{model_id} to retrieve details for a specific model. Replace {model_id} with the actual model ID.

```bash
curl -X GET "http://localhost:8108/nl_search_models/{model_id}" \
-H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"

```

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

### Python: Initialize Typesense Client

Source: https://typesense.org/docs/29.0/api/authentication.html

Creates a Typesense client in Python with node configuration and API key. Use the commented host/port/protocol values for Typesense Cloud.

```python
import typesense

client = typesense.Client({
  'nodes': [{
    'host': 'localhost',  # For Typesense Cloud use xxx.a1.typesense.net
    'port': '8108',       # For Typesense Cloud use 443
    'protocol': 'http'    # For Typesense Cloud use https
  }],
  'api_key': '<API_KEY>',
  'connection_timeout_seconds': 2
})
```

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

### Create product_queries collection (Go)

Source: https://typesense.org/docs/29.0/api/analytics-query-suggestions.md

Creates a collection named 'product_queries' with mandatory 'q' and 'count' fields. This collection is automatically populated by Typesense with search queries.

```go
schema := &api.CollectionSchema{
  Name: "product_queries",
  Fields: []api.Field{
    {Name: "q", Type: "string"},
    {Name: "count", Type: "int32"},
  }}

client.Collections().Create(context.Background(), schema)
```

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

### PHP: Initialize Typesense Client

Source: https://typesense.org/docs/29.0/api/authentication.html

Creates a Typesense client in PHP with an API key, node configuration, and connection timeout. Use the commented host/port/protocol values for Typesense Cloud.

```php
use Typesense\Client;

$client = new Client(
  [
    'api_key'         => 'abcd',
    'nodes'           => [
      [
        'host'     => 'localhost',  // For Typesense Cloud use xxx.a1.typesense.net
        'port'     => '8108',       // For Typesense Cloud use 443
        'protocol' => 'http',       // For Typesense Cloud use https
      ],
    ],
    'connection_timeout_seconds' => 2,
  ]
);
```

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

### Union search with mismatched sort_by fields

Source: https://typesense.org/docs/29.0/api/federated-multi-search.html

Shows an example of a union search where the sort_by fields have different types, which will return an error. The example uses user_name:asc and rating:asc.

```json
{
  "union": true,
  "searches": [
    {
      ...
      "sort_by": "user_name:asc"
      ...
    },
    {
      ...
      "sort_by": "rating:asc"
      ...
    }
  ]
}

```

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

### JavaScript: Initialize Typesense.Client and SearchClient

Source: https://typesense.org/docs/29.0/api/authentication.html

Shows two ways to create a client in JavaScript: the full Client for all API operations and the SearchClient for search-only use in the browser. The comment warns to use a search-only API key in the browser to avoid exposing write access.

```javascript
/*
 *  Our JavaScript client library works on both the server and the browser.
 *  When using the library on the browser, please be sure to use an
 *  API Key that only has search permissions rather than the master API key since the latter
 *  has write access to Typesense and you don't want to expose that.
 */

const Typesense = require('typesense')

let client = new Typesense.Client({
  'nodes': [{
    'host': 'localhost', // For Typesense Cloud use xxx.a1.typesense.net
    'port': '8108',      // For Typesense Cloud use 443
    'protocol': 'http'   // For Typesense Cloud use https
  }],
  'apiKey': '<API_KEY>',
  'connectionTimeoutSeconds': 2
})

// Typesense.Client() has methods for all API operations.
// If you only intend to search through documents (for eg: in the browser),
//    you can also use Typesense.SearchClient().
// This can also help reduce your bundle size by only including the classes you need:

import { SearchClient as TypesenseSearchClient } from "typesense";
let client = new TypesenseSearchClient({
  'nodes': [{
    'host': 'localhost', // For Typesense Cloud use xxx.a1.typesense.net
    'port': '8108',      // For Typesense Cloud use 443
    'protocol': 'http'   // For Typesense Cloud use https
  }],
  'apiKey': '<API_KEY>',
  'connectionTimeoutSeconds': 2
})
```

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

### Check schema change status (curl GET)

Source: https://typesense.org/docs/29.0/api/collections.md

Use this curl command to check the status of in-progress schema change operations. If no changes are in progress, you'll get an empty response.

```bash
curl "http://localhost:8108/operations/schema_changes" \
     -X GET \
     -H "Content-Type: application/json" \
     -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"
```

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

### Go: Import documents with action=create

Source: https://typesense.org/docs/29.0/api/documents.html

Shows how to import a single document into the 'companies' collection using the Go client. The document is defined as a struct with JSON tags. The import uses the Create action. Important: increase connectionTimeoutSeconds to at least 5 minutes for imports.

```go
documents := []interface{}{
  struct {
    ID           string `json:"id"`
    CompanyName  string `json:"companyName"`
    NumEmployees int    `json:"numEmployees"`
    Country      string `json:"country"`
  }{
    ID:           "124",
    CompanyName:  "Stark Industries",
    NumEmployees: 5215,
    Country:      "USA",
  },
}

params := &api.ImportDocumentsParams{
  Action:    pointer.Any(api.Create),
}

// IMPORTANT: Be sure to increase connectionTimeoutSeconds to at least 5 minutes or more for imports,
//  when instantiating the client

client.Collection("companies").Documents().Import(context.Background(), documents, params)

```

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

### JSONL format example for importing documents

Source: https://typesense.org/docs/29.0/api/documents.html

Documents must be formatted as newline-delimited JSON (JSONL), one JSON object per line without commas. This example shows three documents.

```jsonl
{"id": "124", "company_name": "Stark Industries", "num_employees": 5215, "country": "US"}
{"id": "125", "company_name": "Future Technology", "num_employees": 1232, "country": "UK"}
{"id": "126", "company_name": "Random Corp.", "num_employees": 531, "country": "AU"}
```

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

### Example response for schema change status (JSON)

Source: https://typesense.org/docs/29.0/api/collections.md

Example JSON response from the schema changes endpoint when a schema change is in progress. Shows the collection being altered, number of documents validated, and number altered.

```json
[
  {
    "collection": "companies",
    "validated_docs": 873000,
    "altered_docs": 0
  }
]
```

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

### List all synonyms in PHP

Source: https://typesense.org/docs/29.0/api/synonyms.md

Lists all synonyms for the 'products' collection using the PHP client.

```php
$client->collections['products']->synonyms->retrieve();
```

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

### Multi-search query suggestions and results (Go)

Source: https://typesense.org/docs/29.0/api/analytics-query-suggestions.md

Sends a multi_search request to the 'product_queries' collection for query suggestions and the 'products' collection for results, both with query 'shoe'. Uses the client.MultiSearch.Perform method.

```go
searchRequests := api.MultiSearchSearchesParameter{
  Searches: []api.MultiSearchCollectionParameters{
    {
      Collection: pointer.Any("product_queries"),
      Q:          pointer.Any("shoe"),
      QueryBy:    pointer.Any("q"),
    },
    {
      Collection: pointer.Any("products"),
      Q:          pointer.Any("shoe"),
      QueryBy:    pointer.Any("product_name"),
    },
  },
}

client.MultiSearch.Perform(context.Background(), &api.MultiSearchParams{}, searchRequests)
```

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

### GET /stopwords

Source: https://typesense.org/docs/29.0/api/stopwords.md

Lists all stopwords sets.

```APIDOC
## GET /stopwords

### Description
Lists all stopwords sets.

### Method
GET

### Endpoint
/stopwords

### Parameters
None

### Request Example
No request body required.

### Response
#### Success Response (200)
No response schema provided in the source.
```

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

### List all synonyms in Python

Source: https://typesense.org/docs/29.0/api/synonyms.md

Lists all synonyms for the 'products' collection using the Python client.

```python
client.collections['products'].synonyms.retrieve()
```

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

### Natural Language Search Response Example

Source: https://typesense.org/docs/29.0/api/natural-language-search.html

Example JSON response from a natural language search query. Shows the structure with found count, hits, highlights, parsed_nl_query, and request_params. The parsed_nl_query includes generated and augmented parameters. Use exclude_fields=parsed_nl_query to omit that section.

```json
{
  "found": 42,
  "hits": [
    {
      "document": {
        "id": "124",
        "name": "Classic Red Shirt",
        "description": "Comfortable cotton shirt in vibrant red",
        "price": 24.99,
        "color": "red",
        "category": "shirt"
      },
      "highlights": [
        {
          "field": "name",
          "snippet": "Classic <mark>Red</mark> T-<mark>Shirt</mark>"
        }
      ]
    },
    // ... more hits
  ],
  "parsed_nl_query": {
    "parse_time_ms": 428,
    "generated_params": {
      "filter_by": "color:red && category:shirt && price:<50",
      "sort_by": "price:asc"
    },
    "augmented_params": {
      "q": "*",
      "filter_by": "in_stock:true && color:red && category:shirt && price:<50",
      "sort_by": "price:asc",
      "query_by": "name,description,color,category"
    }
  },
  "request_params": {
    "q": "show me red shirts under $50",
    "nl_query": true,
    "query_by": "name,description,color,category",
    "filter_by": "in_stock:true"
  }
}
```

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

### Java: Initialize Typesense Client

Source: https://typesense.org/docs/29.0/api/authentication.html

Creates a Typesense client in Java by building a list of nodes and a Configuration object. Use the commented host/port/protocol values for Typesense Cloud.

```java
import org.typesense.api.*;
import org.typesense.models.*;
import org.typesense.resources.*;

ArrayList<Node> nodes = new ArrayList<>();
nodes.add(
  new Node(
    "http",       // For Typesense Cloud use https
    "localhost",  // For Typesense Cloud use xxx.a1.typesense.net
    "8108"        // For Typesense Cloud use 443
  )
);

Configuration configuration = new Configuration(nodes, Duration.ofSeconds(2),"<API_KEY>");

Client client = new Client(configuration);
```

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

### GET /stemming/dictionaries

Source: https://typesense.org/docs/29.0/api/stemming.md

Lists all stemming dictionaries available in the system.

```APIDOC
## GET /stemming/dictionaries

### Description
Lists all stemming dictionaries available in the system.

### Method
GET

### Endpoint
/stemming/dictionaries

### Request Example
```bash
curl -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
  "http://localhost:8108/stemming/dictionaries"
```

### Response
#### Success Response (200)
- **dictionaries** (array of strings) - List of dictionary IDs.

#### Response Example
```json
{
  "dictionaries": ["irregular-plurals", "company-terms"]
}
```
```

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

### Sort by filter score with custom scores in _eval()

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

Assigns custom scores to records matching filter clauses inside '_eval'. Here, Nike shoes get a score of 3 and Adidas shoes get 2, ranking Nike ahead of Adidas when sorted descending.

```json
{
  "sort_by": "_eval([ (brand:Nike):3, (brand:Adidas):2 ]):desc"
}
```

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

### List all synonyms in Ruby

Source: https://typesense.org/docs/29.0/api/synonyms.md

Lists all synonyms for the 'products' collection using the Ruby client.

```ruby
client.collections['products'].synonyms.retrieve
```

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

### GET /stemming/dictionaries/{id}

Source: https://typesense.org/docs/29.0/api/stemming.md

Retrieves a specific stemming dictionary by its ID.

```APIDOC
## GET /stemming/dictionaries/{id}

### Description
Retrieves a specific stemming dictionary by its ID.

### Method
GET

### Endpoint
/stemming/dictionaries/{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The dictionary identifier.

### Request Example
```bash
curl -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
  "http://localhost:8108/stemming/dictionaries/irregular-plurals"
```

### Response
#### Success Response (200)
- The dictionary object (not shown in source).
```

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

### Swift: Initialize Typesense Client

Source: https://typesense.org/docs/29.0/api/authentication.html

Creates a Typesense client in Swift using Node and Configuration. Use the commented host/port/protocol values for Typesense Cloud.

```swift
import Typesense

let node = Node(
  host: "localhost",    // For Typesense Cloud use xxx.a1.typesense.net
  port: "8108",         // For Typesense Cloud use 443
  nodeProtocol: "http"  // For Typesense Cloud use https
)

let config = Configuration(nodes: [node], apiKey: "<API_KEY>", connectionTimeoutSeconds: 2)

let client = Client(config: config)
```

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

### GET /aliases

Source: https://typesense.org/docs/29.0/api/collection-alias.md

Lists all collection aliases and the corresponding collections they map to.

```APIDOC
## GET /aliases

### Description
Lists all collection aliases and the corresponding collections they map to.

### Method
GET

### Endpoint
`GET ${TYPESENSE_HOST}/aliases`

### Parameters
No parameters.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **aliases** (array) - List of alias objects.
  - **name** (string) - The name of the alias.
  - **collection_name** (string) - The name of the collection the alias points to.

#### Response Example
```json
{
  "aliases": [
    {
      "name": "companies",
      "collection_name": "companies_june11"
    },
    {
      "name": "employees",
      "collection_name": "employees_june11"
    }
  ]
}
```
```

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

### GET /analytics/rules

Source: https://typesense.org/docs/29.0/api/analytics-query-suggestions.md

Lists all analytics rules stored in the Typesense cluster.

```APIDOC
## GET /analytics/rules

### Description
Lists all analytics rules stored in the Typesense cluster.

### Method
GET

### Endpoint
/analytics/rules

### Parameters
None

### Request Example
No request body required.

### Response
#### Success Response (200)
- **rules** (array) - List of analytics rule objects.

#### Response Example
```json
{
  "rules": []
}
```
```

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

### GET /stopwords/{stopwords_set_id}

Source: https://typesense.org/docs/29.0/api/stopwords.md

Retrieves the stopwords associated with a specific stopwords set.

```APIDOC
## GET /stopwords/{stopwords_set_id}

### Description
Retrieves the stopwords associated with a specific stopwords set.

### Method
GET

### Endpoint
/stopwords/{stopwords_set_id}

### Parameters
#### Path Parameters
- **stopwords_set_id** (string) - Required - The ID of the stopwords set to retrieve.

### Request Example
No request body required.

### Response
#### Success Response (200)
No response schema provided in the source.
```

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

### Create collection with OpenAI-compatible API using Python

Source: https://typesense.org/docs/29.0/api/vector-search.md

Creates a 'products' collection using an OpenAI-compatible API provider. The model_config includes a custom URL for the provider.

```python
schema = {
  "name": "products",
  "fields": [
    {
      "name" : "product_name",
      "type" : "string"
    },
    {
      "name" : "embedding",
      "type" : "float[]",
      "embed": {
        "from": [
          "product_name"
        ],
        "model_config": {
          "model_name": "openai/text-embedding-ada-002",
          "api_key": "your_api_key_as_required_by_the_custom_provider",
          "url": "https://your-custom-openai-compatible-api.domain.com"
        }
      }
    }
  ]
}

client.collections.create(schema)
```

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

### List all synonyms in Java

Source: https://typesense.org/docs/29.0/api/synonyms.md

Lists all synonyms for the 'products' collection using the Java client.

```java
SearchSynonymsResponse searchSynonymsResponse =  client.collections("products").synonyms().retrieve();
```

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

### GET /nl_search_models

Source: https://typesense.org/docs/29.0/api/natural-language-search.html

Lists all natural language search models configured in the Typesense instance.

```APIDOC
## [GET] /nl_search_models

### Description
Lists all natural language search models configured in the Typesense instance.

### Method
GET

### Endpoint
http://localhost:8108/nl_search_models

### Parameters
#### Headers
- **X-TYPESENSE-API-KEY** (string) - Required - The API key for authentication.

### Request Example
```
curl -X GET "http://localhost:8108/nl_search_models" \
-H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"
```

### Response
#### Success Response (200)
- **models** (array) - List of natural language search models.

#### Response Example
```json
{
  "models": []
}
```
```

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

### Import JSONL file using Go client

Source: https://typesense.org/docs/29.0/api/documents.html

Opens a JSONL file and imports it into the 'companies' collection with action 'create' using the Typesense Go client.

```go
params := &api.ImportDocumentsParams{
	Action: pointer.Any(api.Create),
}
documentsInJsonl, err := os.Open("documents.jsonl")
// defer close, error handling ...

client.Collection("companies").Documents().ImportJsonl(context.Background(), documentsInJsonl, params)

```

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

### GET /collections/:collection/synonyms/:id

Source: https://typesense.org/docs/29.0/api/synonyms.md

Retrieves a single synonym by its ID from a specified collection.

```APIDOC
## GET /collections/:collection/synonyms/:id

### Description
Retrieves a single synonym by its ID from a specified collection.

### Method
GET

### Endpoint
`GET ${TYPESENSE_HOST}/collections/:collection/synonyms/:id`

### Parameters
#### Path Parameters
- **collection** (string) - Required - The name of the collection.
- **id** (string) - Required - The ID of the synonym to retrieve.

### Response
#### Success Response (200)
- **id** (string) - The synonym ID.
- **root** (string) - The root word.
- **synonyms** (array of strings) - The list of synonyms.

#### Response Example
```json
{
  "id": "coat-synonyms",
  "root": "",
  "synonyms": ["blazer", "coat", "jacket"]
}
```
```

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

### Get a specific stopwords set

Source: https://typesense.org/docs/29.0/api/stopwords.md

Retrieves the stopwords associated with the set named 'countries'.

```shell
curl -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" \
  "http://localhost:8108/stopwords/countries" 
```

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

### GET /aliases/:alias

Source: https://typesense.org/docs/29.0/api/collection-alias.md

Retrieves a specific collection alias to find out which collection it points to.

```APIDOC
## GET /aliases/:alias

### Description
Retrieves a specific collection alias to find out which collection it points to.

### Method
GET

### Endpoint
`GET ${TYPESENSE_HOST}/aliases/:alias`

### Parameters
#### Path Parameters
- **alias** (string) - Required - The name of the alias to retrieve.

### Request Example
No request body required.

### Response
#### Success Response (200)
- **name** (string) - The name of the alias.
- **collection_name** (string) - The name of the collection the alias points to.

#### Response Example
```json
{
  "name": "companies",
  "collection_name": "companies_june11"
}
```
```

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

### Create collection with OpenAI-compatible API using Ruby

Source: https://typesense.org/docs/29.0/api/vector-search.md

Creates a 'products' collection using an OpenAI-compatible API provider. The model_config includes a custom URL for the provider.

```ruby
schema = {
  "name" => "products",
  "fields" => [
    {
      "name" => "product_name",
      "type" => "string"
    },
    {
      "name" => "embedding",
      "type" => "float[]",
      "embed" => {
        "from" => [
          "product_name"
        ],
        "model_config" => {
          "model_name" => "openai/text-embedding-ada-002",
          "api_key" => "your_api_key_as_required_by_the_custom_provider",
          "url" => "https://your-custom-openai-compatible-api.domain.com"
        }
      }
    }
  ]
}

client.collections.create(schema)
```

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

### GET /conversations/models

Source: https://typesense.org/docs/29.0/api/conversational-search-rag.html

Retrieves all conversation models. This endpoint returns a list of all configured models.

```APIDOC
## GET /conversations/models

### Description
Retrieves all conversation models.

### Method
GET

### Endpoint
`/conversations/models`

### Parameters
#### Headers
- **X-TYPESENSE-API-KEY** (string) - Required - The API key for authentication.

### Request Example
```
curl 'http://localhost:8108/conversations/models' \
  -X GET \
  -H 'Content-Type: application/json' \
  -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}"
```

### Response
#### Success Response (200)
- Returns a list of conversation models.

#### Response Example
(No response example provided in the source.)

```
Tokens:
Raw