class Meilisearch::Crystal::IndexClient

• Meilisearch::Crystal::IndexClient
• Reference
• Object

Overview

A client handle bound to one index uid.

Defined in:

meilisearch/crystal/index_client.cr

Constructors

• .new(client : Client, uid : String)

Instance Method Summary

• #client : Client
• #delete : TaskResult

  Deletes the bound index.

• #documents : Documents

  Document operations scoped to this index.

• #facet_search(request : FacetSearchRequest) : FacetSearchResponse
• #metadata : Index

  Fetches the current typed metadata snapshot for this index.

• #reset_settings : TaskResult
• #search(query : Query, as type : T.class) : SearchResponse(T) forall T
• #search(q : String | Nil, as type : T.class) : SearchResponse(T) forall T
• #search(query : Query) : SearchResponse(JSON::Any)

  Searches this index with a typed query object.

• #search(q : String | Nil = nil) : SearchResponse(JSON::Any)

  Searches this index from a query string.

• #settings : Settings

  Fetches this index's current typed settings.

• #similar(id : String | Int32 | Int64, embedder : String, as type : T.class) : SearchResponse(T) forall T
• #similar(id : String | Int32 | Int64, embedder : String) : SearchResponse(JSON::Any)
• #stats : Index::Stats
• #tasks(limit : Int32 | Nil = nil) : List(Task)
• #uid : String
• #update(primary_key : String | Nil = nil, new_uid : String | Nil = nil) : TaskResult

  Updates the bound index's primary key or uid.

• #update_settings(settings : Settings) : TaskResult
• #with_tenant_token(api_key_uid : String, search_rules, expires_at : Time | Nil = nil, api_key : String | Nil = client.api_key) : IndexClient

Constructor Detail

Instance Method Detail