algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.api/CompositionClient

CompositionClient

algoliasearch.api.CompositionClient
See theCompositionClient companion object
class CompositionClient(appId: String, apiKey: String, clientOptions: ClientOptions) extends ApiClient

Attributes

Companion
object
Graph
Supertypes
class ApiClient
trait AutoCloseable
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

def search(compositionID: String, requestBody: RequestBody, requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[SearchResponse]

Runs a query on a single composition and returns matching results.

Runs a query on a single composition and returns matching results.

Required API Key ACLs:

  • search

Value parameters

compositionID

Unique Composition ObjectID.

Attributes

def searchForFacetValues(compositionID: String, facetName: String, searchForFacetValuesRequest: Option[SearchForFacetValuesRequest], requestOptions: Option[RequestOptions])(implicit ec: ExecutionContext): Future[SearchForFacetValuesResponse]

Searches for values of a specified facet attribute on the composition's main source's index. - By default, facet values are sorted by decreasing count. You can adjust this with the sortFacetValueBy parameter. - Searching for facet values doesn't work if you have more than 65 searchable facets and searchable attributes combined.

Searches for values of a specified facet attribute on the composition's main source's index. - By default, facet values are sorted by decreasing count. You can adjust this with the sortFacetValueBy parameter. - Searching for facet values doesn't work if you have more than 65 searchable facets and searchable attributes combined.

Required API Key ACLs:

  • search

Value parameters

compositionID

Unique Composition ObjectID.

facetName

Facet attribute in which to search for values. This attribute must be included in the attributesForFaceting index setting with the searchable() modifier.

Attributes

Inherited methods

override def close(): Unit

Attributes

Definition Classes
ApiClient -> AutoCloseable
Inherited from:
ApiClient
def setClientApiKey(apiKey: String): Unit

Attributes

Inherited from:
ApiClient
Generated with