Index a document.

Examples

iex> document = %{
  company_name: "Stark Industries",
  num_employees: 5215,
  country: "USA"
}
iex> Typesense.Documents.create(collection, document)
{:ok, document}

Delete a document.

Options

• :id - The id of the document to be deleted
• :query - The map of params to filter the delete by

Examples

iex> Typesense.Documents.delete(collection, id \ nil, query \ %{})
{:ok, _document}

Export documents from a collection.

Examples

iex> Typesense.Documents.export(collection)
[%{}, ...]

Import documents into a collection.

Examples

iex> documents = [{
  id: "124",
  company_name: "Stark Industries",
  num_employees: 5215,
  country: "USA"
}]
iex> Typesense.Documents.import(collection, documents, :create)
{:ok, documents}

Retrieve a document.

Examples

iex> args = %{
  limit_multi_searches
}
iex> Typesense.Documents.retrieve(collection, id)
{:ok, document}

Search for documents.

Examples

iex> search_params = %{
  q: "stark",
  query_by: "company_name",
  filter_by: "num_employees:>100",
  sort_by: "num_employees:desc"
}
iex> Typesense.Documents.search(collection, search_params)
iex> {:ok, documents}

Update a document.

Examples

iex> Typesense.Documents.update(collection, id, document)
{:ok, document}