Typesense 快速入门

快速入门

这是一个简单示例，展示如何创建集合、索引文档并在 Typesense 上搜索它。

让我们首先通过 Docker 启动 Typesense 服务器：

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

我们有几种语言的API 客户端，但本示例我们将使用 Python 客户端。

安装 Typesense 的 Python 客户端：

pip install typesense

我们现在可以初始化客户端并创建一个companies集合：

import typesense

client = typesense.Client({
  'api_key': 'Hu52dwsas2AdxdE',
  'nodes': [{
    'host': 'localhost',
    'port': '8108',
    'protocol': 'http'
  }],
  'connection_timeout_seconds': 2
})

create_response = client.collections.create({
  "name": "companies",
  "fields": [
    {"name": "company_name", "type": "string" },
    {"name": "num_employees", "type": "int32" },
    {"name": "country", "type": "string", "facet": True }
  ],
  "default_sorting_field": "num_employees"
})

现在，让我们将文档添加到刚刚创建的集合中：

document = {
 "id": "124",
 "company_name": "Stark Industries",
 "num_employees": 5215,
 "country": "USA"
}

client.collections['companies'].documents.create(document)

最后，让我们搜索刚刚索引的文档：

search_parameters = {
  'q'         : 'stork',
  'query_by'  : 'company_name',
  'filter_by' : 'num_employees:>100',
  'sort_by'   : 'num_employees:desc'
}

client.collections['companies'].documents.search(search_parameters)

您是否注意到查询文本中的拼写错误？没什么大不了的。Typesense 可以立即处理印刷错误！

逐步指导

我们的网站上提供了分步指南。

这将指导您完成启动 Typesense 服务器、索引数据和查询数据集的过程。

API 文档

这是我们的官方 API 文档，可在我们的网站上查阅：https://typesense.org/api

如果您发现文档或演练中存在任何问题，请告知我们或在此处向我们发送 PR：https://github.com/typesense/typesense-website。

API 客户端

虽然您当然可以使用 CURL 直接与 Typesense 服务器交互，但我们提供官方 API 客户端，以简化使用您选择的语言的 Typesense。API 客户端内置智能重试策略，以确保通过它们进行的 API 调用具有弹性，尤其是在 HA 设置中。

• JavaScript
• PHP
• Python
• Ruby

如果我们没有提供您所用语言的 API 客户端，您仍然可以使用任何流行的 HTTP 客户端库直接访问 Typesense 的 API。

以下是一些社区贡献的客户端和集成：

• Go
• .Net
• Java
• Rust
• Dart
• Perl
• Swift
• Clojure
• python orm client
• PHP SEAL Adapter
• Elixir