Api clients / Ruby / V1 / Methods

Get Object Position | Ruby API Client V1 (Deprecated)

Deprecated content
This documentation is for a deprecated version of Ruby API client . Some features and settings may be missing or their usage may have changed. Refer to the documentation for the latest version of Ruby API client for up-to-date information.
Required API Key: no ACL required
Method signature
Algolia::Index.get_object_position(Array results, string objectId)

About this method

Retrieve the given object’s position in the given results set. Can be used to debug relevance.

getObjectPosition may be used to debug the relevance of an objectID in specific results set. If the objectID is found, the position of the object is returned.

Examples

1
$position = SearchIndex::getObjectPosition($results, 'a-unique-identifier');

Parameters

results
type: key/value mapping
Required

The results set of a search.

objectId
type: string
Required

The objectID of the record.

class
type: class
Required

Only for Java and Scala: the type of the hits.

Response

No response.

Did you find this page helpful?