Skip to content

Commit

Permalink
Merge branch 'main' into v27
Browse files Browse the repository at this point in the history
  • Loading branch information
kishorenc committed Apr 23, 2024
2 parents 36056fe + d7b65d3 commit 7c95ce4
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Expand Up @@ -22,8 +22,7 @@
<a href="https://github.com/orgs/typesense/projects/1">Roadmap</a> |
<a href="https://join.slack.com/t/typesense-community/shared_invite/zt-2fetvh0pw-ft5y2YQlq4l_bPhhqpjXig">Slack Community</a> |
<a href="https://threads.typesense.org/kb">Community Threads</a> |
<a href="https://twitter.com/typesense">Twitter</a> |
<a href="https://calendly.com/jason-typesense/typesense-office-hours">Office Hours</a>
<a href="https://twitter.com/typesense">Twitter</a>
</p>
<br>
<p align="center">
Expand Down Expand Up @@ -79,7 +78,11 @@
- **Geo Search:** Search and sort by results around a latitude/longitude or within a bounding box.
- **Vector Search:** Index embeddings from your machine learning models in Typesense and do a nearest-neighbor search. Can be used to build similarity search, semantic search, visual search, recommendations, etc.
- **Semantic / Hybrid Search:** Automatically generate embeddings from within Typesense using built-in models like S-BERT, E-5, etc or use OpenAI, PaLM API, etc, for both queries and indexed data. This allows you to send JSON data into Typesense and build an out-of-the-box semantic search + keyword search experience.
- **Conversational Search (Built-in RAG):** Send questions to Typesense and have the response be a fully-formed sentence, based on the data you've indexed in Typesense. Think ChatGPT, but over your own data.
- **Image Search:** Search through images using text descriptions of their contents, or perform similarity searches, using the CLIP model.
- **Voice Search:** Capture and send query via voice recordings - Typesense will transcribe (via Whisper model) and provide search results.
- **Scoped API Keys:** Generate API keys that only allow access to certain records, for multi-tenant applications.
- **JOINs:** Connect one or more collections via common reference fields and join them during query time. This allows you to model SQL-like relationships elegantly.
- **Synonyms:** Define words as equivalents of each other, so searching for a word will also return results for the synonyms defined.
- **Curation & Merchandizing:** Boost particular records to a fixed position in the search results, to feature them.
- **Raft-based Clustering:** Setup a distributed cluster that is highly available.
Expand Down Expand Up @@ -137,7 +140,7 @@ Here's a quick example showcasing how you can create a collection, index a docum
Let's begin by starting the Typesense server via Docker:

```
docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:0.25.2 --data-dir /data --api-key=Hu52dwsas2AdxdE
docker run -p 8108:8108 -v/tmp/data:/data typesense/typesense:26.0 --data-dir /data --api-key=Hu52dwsas2AdxdE
```

We have [API Clients](#api-clients) in a couple of languages, but let's use the Python client for this example.
Expand Down Expand Up @@ -348,9 +351,7 @@ If you have specifics that prevent you from using Typesense due to a licensing i

## Support

πŸ‘‹ 🌐 If you have general questions about Typesense, want to say hello or just follow along, we'd like to invite you to join our [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-2fetvh0pw-ft5y2YQlq4l_bPhhqpjXig).

We also do virtual office hours every Friday. Reserve a time slot [here](https://calendly.com/jason-typesense/typesense-office-hours).
πŸ‘‹ 🌐 If you have general questions about Typesense, want to say hello or just follow along, we'd like to invite you to join our public [Slack Community](https://join.slack.com/t/typesense-community/shared_invite/zt-2fetvh0pw-ft5y2YQlq4l_bPhhqpjXig).

If you run into any problems or issues, please create a GitHub issue and we'll try our best to help.

Expand All @@ -359,10 +360,10 @@ We strive to provide good support through our issue trackers on GitHub. However,
- Guaranteed SLAs
- Phone / video calls to discuss your specific use case and get recommendations on best practices
- Private discussions over Slack
- Guidance around deployment, ops and scaling best practices
- Guidance around scaling best practices
- Prioritized feature requests

We do offer Paid Support options. Please reach out to us at contact@typesense.org to sign up.
We offer Paid Support options described [here](https://typesense.org/support/).

## Contributing

Expand Down

0 comments on commit 7c95ce4

Please sign in to comment.