@spec delete_document(String.t(), String.t()) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a document

Delete an individual document from a collection by using its ID.

Options

• ignore_not_found: Ignore the error and treat the deletion as success.

@spec delete_document(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t(),
  String.t() | keyword()
) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• delete_document(collectionName, documentId, opts)
• delete_document(%{api_key: xyz, host: ...}, collectionName, documentId)
• delete_document(Connection.new(), collectionName, documentId)

@spec delete_document(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• delete_document(%{api_key: xyz, host: ...}, collectionName, documentId, opts)
• delete_document(Connection.new(), collectionName, documentId, opts)

@spec delete_documents(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Delete a bunch of documents

Delete a bunch of documents that match a specific filter condition. Use the batch_size parameter to control the number of documents that should deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.

Options

• batch_size: Batch size parameter controls the number of documents that should be deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.
• filter_by: Filter results by a particular value(s) or logical expressions. multiple conditions with &&.

@spec delete_documents(map() | OpenApiTypesense.Connection.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• delete_documents(collectionName, batch_size: 50, filter_by: "persons_id:>100")
• delete_documents(%{api_key: xyz, host: ...}, collectionName, opts)
• delete_documents(Connection.new(), collectionName, opts)

@spec delete_search_override(String.t(), String.t()) ::
  {:ok, OpenApiTypesense.SearchOverrideDeleteResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Delete an override associated with a collection

@spec delete_search_override(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t(),
  String.t() | keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverrideDeleteResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• delete_search_override(overrideId, opts)
• delete_search_override(%{api_key: xyz, host: ...}, overrideId)
• delete_search_override(Connection.new(), overrideId)

@spec delete_search_override(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverrideDeleteResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• delete_search_override(%{api_key: xyz, host: ...}, overrideId, opts)
• delete_search_override(Connection.new(), overrideId, opts)

@spec export_documents(String.t()) ::
  {:ok, String.t()} | {:error, OpenApiTypesense.ApiResponse.t()}

Export all documents in a collection

Export all documents in a collection in JSON lines format.

Options

• filter_by: Filter conditions for refining your search results. Separate multiple conditions with &&.
• include_fields: List of fields from the document to include in the search result
• exclude_fields: List of fields from the document to exclude in the search result

@spec export_documents(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t() | keyword()
) ::
  {:ok, String.t()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• export_documents(collectionName, opts)
• export_documents(%{api_key: xyz, host: ...}, collectionName)
• export_documents(Connection.new(), collectionName)

@spec export_documents(map() | OpenApiTypesense.Connection.t(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• export_documents(%{api_key: xyz, host: ...}, collectionName, opts)
• export_documents(Connection.new(), collectionName, opts)

@spec get_document(String.t(), String.t()) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a document

Fetch an individual document from a collection by using its ID.

Options

• include_fields: List of fields that should be present in the returned document.
• exclude_fields: List of fields that should not be present in the returned document.

@spec get_document(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t(),
  String.t() | keyword()
) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• get_document(collectionName, documentId, opts)
• get_document(%{api_key: xyz, host: ...}, collectionName, documentId)
• get_document(Connection.new(), collectionName, documentId)

@spec get_document(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• get_document(%{api_key: xyz, host: ...}, collectionName, documentId, opts)
• get_document(Connection.new(), collectionName, documentId, opts)

@spec get_search_override(String.t(), String.t()) ::
  {:ok, OpenApiTypesense.SearchOverride.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Retrieve a single search override

Retrieve the details of a search override, given its id.

@spec get_search_override(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t(),
  String.t() | keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverride.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• get_search_override(collectionName, overrideId, opts)
• get_search_override(%{api_key: xyz, host: ...}, collectionName, overrideId)
• get_search_override(Connection.new(), collectionName, overrideId)

@spec get_search_override(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverride.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• get_search_override(%{api_key: xyz, host: ...}, collectionName, overrideId, opts)
• get_search_override(Connection.new(), collectionName, overrideId, opts)

@spec get_search_overrides(String.t()) ::
  {:ok, OpenApiTypesense.SearchOverridesResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

List all collection overrides

@spec get_search_overrides(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t() | keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverridesResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• get_search_overrides(collectionName, opts)
• get_search_overrides(%{api_key: xyz, host: ...}, collectionName)
• get_search_overrides(Connection.new(), collectionName)

@spec get_search_overrides(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverridesResponse.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• get_search_overrides(%{api_key: xyz, host: ...}, collectionName, opts)
• get_search_overrides(Connection.new(), collectionName, opts)

@spec import_documents(String.t(), String.t()) ::
  {:ok, String.t()} | {:error, OpenApiTypesense.ApiResponse.t()}

Import documents into a collection

The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import.

Options

• batch_size: Batch size parameter controls the number of documents that should be imported at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.
• return_id: Returning the id of the imported documents. If you want the import response to return the ingested document's id in the response, you can use the return_id parameter.
• remote_embedding_batch_size: Max size of each batch that will be sent to remote APIs while importing multiple documents at once. Using lower amount will lower timeout risk, but increase number of requests made. Default is 200.
• remote_embedding_timeout_ms: How long to wait until an API call to a remote embedding service is considered a timeout during indexing. Default is 60_000 ms
• remote_embedding_num_tries: The number of times to retry an API call to a remote embedding service on failure during indexing. Default is 2.
• return_doc: Returns the entire document back in response.
• action: Additional action to perform
• dirty_values: Dealing with Dirty Data

@spec import_documents(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t(),
  String.t() | keyword()
) :: {:ok, String.t()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• import_documents(collectionName, payload, opts)
• import_documents(%{api_key: xyz, host: ...}, collectionName, payload)
• import_documents(Connection.new(), collectionName, payload)

@spec import_documents(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, String.t()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• import_documents(%{api_key: xyz, host: ...}, collectionName, payload, opts)
• import_documents(Connection.new(), collectionName, payload, opts)

@spec index_document(String.t(), map()) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Index a document

A document to be indexed in a given collection must conform to the schema of the collection.

Options

• action: Additional action to perform
• dirty_values: Dealing with Dirty Data

@spec index_document(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t() | map(),
  map() | keyword()
) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• index_document(collectionName, payload, opts)
• index_document(%{api_key: xyz, host: ...}, collectionName, payload)
• index_document(Connection.new(), collectionName, payload)

@spec index_document(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  map(),
  keyword()
) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• index_document(%{api_key: xyz, host: ...}, collectionName, payload, opts)
• index_document(Connection.new(), collectionName, payload, opts)

@spec multi_search(OpenApiTypesense.MultiSearchSearchesParameter.t()) ::
  {:ok, OpenApiTypesense.MultiSearchResult.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

send multiple search requests in a single HTTP request

This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request.

Options

• limit_multi_searches: Max number of search requests that can be sent in a multi-search request. Default 50
• x-typesense-api-key: You can embed a separate search API key for each search within a multi_search request. This is useful when you want to apply different embedded filters for each collection in individual scoped API keys.

@spec multi_search(map() | OpenApiTypesense.Connection.t(), map() | keyword()) ::
  {:ok, OpenApiTypesense.MultiSearchResult.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• multi_search(payload, opts)
• multi_search(%{api_key: xyz, host: ...}, payload)
• multi_search(Connection.new(), payload)

@spec multi_search(map() | OpenApiTypesense.Connection.t(), map(), keyword()) ::
  {:ok, OpenApiTypesense.MultiSearchResult.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• multi_search(%{api_key: xyz, host: ...}, payload, opts)
• multi_search(Connection.new(), payload, opts)

@spec search(
  String.t(),
  keyword()
) ::
  {:ok, OpenApiTypesense.SearchResult.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Search for documents in a collection

Search for documents in a collection that match the search criteria.

Options

• searchParameters can be found here: https://typesense.org/docs/latest/api/search.html#search-parameters

Either one of:

• search(collectionName, params)
• search(%{api_key: xyz, host: ...}, collectionName, params)
• search(Connection.new(), collectionName, params)

Example

iex> schema = %{
...>   "name" => "houses",
...>   "fields" => [
...>     %{"name" => "house_type", "type" => "string"},
...>     %{"name" => "houses_id", "type" => "int32"},
...>     %{"name" => "description", "type" => "string"},
...>   ],
...>   "default_sorting_field" => "houses_id",
...> }
iex> OpenApiTypesense.Collections.create_collection(schema)
iex> params = [q: "duplex", query_by: "house_type"]
...> OpenApiTypesense.Documents.search("houses", params)

@spec update_document(String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Update a document

Update an individual document from a collection by using its ID. The update can be partial.

Options

• dirty_values: Dealing with Dirty Data

@spec update_document(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t(),
  String.t() | map(),
  map() | keyword()
) :: {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• update_document(collectionName, documentId, opts)
• update_document(%{api_key: xyz, host: ...}, collectionName, documentId)
• update_document(Connection.new(), collectionName, documentId)

@spec update_document(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• update_document(%{api_key: xyz, host: ...}, collectionName, documentId, opts)
• update_document(Connection.new(), collectionName, documentId, opts)

@spec update_documents(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, OpenApiTypesense.ApiResponse.t()}

Update documents with conditional query

The filter_by query parameter is used to filter to specify a condition against which the documents are matched. The request body contains the fields that should be updated for any documents that match the filter condition. This endpoint is only available if the Typesense server is version 0.25.0.rc12 or later.

Options

• filter_by: Filter results by a particular value(s) or logical expressions. multiple conditions with &&.
• action: Additional action to perform

Either one of:

• update_documents(collectionName, payload, opts)
• update_documents(%{api_key: xyz, host: ...}, collectionName, payload, opts)
• update_documents(Connection.new(), collectionName, payload, opts)

Create or update an override to promote certain documents over others

Create or update an override to promote certain documents over others. Using overrides, you can include or exclude specific documents for a given query.

@spec upsert_search_override(String.t(), String.t(), map(), keyword()) ::
  {:ok, OpenApiTypesense.SearchOverride.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

@spec upsert_search_override(
  map() | OpenApiTypesense.Connection.t() | String.t(),
  String.t(),
  String.t() | map(),
  map() | keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverride.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• upsert_search_override(collectionName, overrideId, payload, opts)
• upsert_search_override(%{api_key: xyz, host: ...}, collectionName, overrideId, payload)
• upsert_search_override(Connection.new(), collectionName, overrideId, payload)

@spec upsert_search_override(
  map() | OpenApiTypesense.Connection.t(),
  String.t(),
  String.t(),
  map(),
  keyword()
) ::
  {:ok, OpenApiTypesense.SearchOverride.t()}
  | {:error, OpenApiTypesense.ApiResponse.t()}

Either one of:

• upsert_search_override(%{api_key: xyz, host: ...}, collectionName, overrideId, payload, opts)
• upsert_search_override(Connection.new(), collectionName, overrideId, payload, opts)