Api clients / JavaScript / V3 / Methods

Jan. 22, 2021

Find Object | JavaScript API Client V3 (Deprecated)

This version of the JavaScript API client has been deprecated in favor of the latest version of the JavaScript API client.

Required API Key: any key with the search ACL

Method signature

index.findObject(function callback)

index.findObject(function callback, {
    // All the following parameters are optional
    'query' => string,
    'paginate' => bool
})

See code examples

About this method

Find an object by the given condition. Can be used to debug relevance.

findObject may be used to debug the relevance of a specific object. This method accepts a condition and returns the first matching object along with its position information in the result set.

Examples

Copy

Copy
$index->findObject(function($obj) {
  return array_key_exists('firstname', $obj) && 'Jimmie' === $obj['firstname'];
});

// With a query
$options1 = [ 'query' => 'query string' ];
$index->findObject(function($obj) {
  return array_key_exists('firstname', $obj) && 'Jimmie' === $obj['firstname'];
}, $options1);

// With a query and only the first page
$options2 = [ 'query' => 'query string', 'paginate' => false ];
$index->findObject(function($obj) {
  return array_key_exists('firstname', $obj) && 'Jimmie' === $obj['firstname'];
}, $options2);

Copy
object = index.find_object { |obj|  obj.key?('firsname') and obj['firsname'] == 'Jimmie' }

# With a query
object = index.find_object({
  'query' => 'query string'
}) { |obj|  obj.key?('firsname') and obj['firsname'] == 'Jimmie' }

# With a query and only in the first page
object = index.find_object({
  'query' => 'query string',
  'paginate' => false
}) { |obj|  obj.key?('firsname') and obj['firsname'] == 'Jimmie' }

Copy
index.findObject(hit => hit.firstname == 'Jimmie', {}, (err, content) => {
  console.log(content);
});

// With a query
const options1 = { query: 'query string' };
index.findObject(hit => hit.firstname == 'Jimmie', options1, (err, content) => {
  console.log(content);
});

// With a query and only in the first page
const options2 = { query: 'query string', paginate: false };
index.findObject(hit => hit.firstname == 'Jimmie', options2, (err, content) => {
  console.log(content);
});

Copy
result = index.find_object(lambda hit: hit.get('firstname') == 'Jimmie')

# With a query
result = index.find_object(lambda hit: hit.get('firstname') == 'Jimmie', {
    'query': 'query string'
})

# With a query and only in the first page
result = index.find_object(lambda hit: hit.get('firstname') == 'Jimmie', {
    'query': 'query string',
    'paginate': False
})

Copy
index.FindObject<Employee>(
  hit => hit.Firstname.Equals("Jimmie"),
  new Query());

// With a query
index.FindObject<Employee>(
  hit => hit.Firstname.Equals("Jimmie"),
  new Query("query string"));

// With a query and only in the first page
index.FindObject<Employee>(
  hit => hit.Firstname.Equals("Jimmie"),
  new Query("query string"),
  false);

Copy
index.findObject(
    x -> x.getFirstName().equals("Jimmie"),
    new Query(""));

// With a query
index.findObject(
    x -> x.getFirstName().equals("Jimmie"),
    new Query("query string"));

// With a query and only in the first page
index.findObject(
    x -> x.getFirstName().equals("Jimmie"),
    new Query("query string"),
    false);

Copy
f := func(o map[string]interface{}) bool {
    itf, ok := o["firstname"]
    if !ok {
        return false
    }
    firstname, ok := itf.(string)
    return ok && firstname == "Jimmie"
}

index.FindObject(f, "", true)

// With a query
index.FindObject(f, "query string", true)

// With a query and only in the first page
index.FindObject(f, "query string", false)

Copy
helper.findObject(
  indexName,
  Query(),
  (e: Employee) => e.firstName == "jimmie")

// With a query
helper.findObject(
  indexName,
  Query(query = Some("query string")),
  (e: Employee) => e.firstName == "jimmie"))

// With a query and only in the first page
helper.findObject(
  indexName,
  Query(query = Some("query string")),
  (e: Employee) => e.firstName == "jimmie",
  paginate = false)

Copy
val match: (ResponseSearch.Hit) -> Boolean = {
    it.json.getPrimitive("firstname").content == "Jimmie"
}
index.findObject(match)
index.findObject(match, Query("query string"))
index.findObject(match, Query("query string"), paginate = false)

Parameters

`callback`	type: function Required The callback used to find the object.
`query`	type: string default: empty string Optional The query used to search.
`paginate`	type: boolean default: true Optional Whether to paginate the search results.
`requestOptions`	type: key value mapping default: No request options Optional A mapping of [`requestOptions`](/doc/api-client/getting-started/request-options/) to send along with the request.
`index`	type: string Required Only for Scala - The name of the index to query.

Response

In this section we document the JSON response returned by the API. Each language will encapsulate this response inside objects specific to the language and/or the implementation. So the actual type in your language might differ from what is documented.

JSON format

Copy

          {
  "object": {
    "firstname": "Jimmie",
    "lastname": "Barninger",
    "_highlightResult": {
      "firstname": {
        "value": "&lt;em&gt;Jimmie&lt;/em&gt;",
        "matchLevel": "partial"
      },
      "lastname": {
        "value": "Barninger",
        "matchLevel": "none"
      },
      "company": {
        "value": "California &lt;em&gt;Paint&lt;/em&gt; & Wlpaper Str",
        "matchLevel": "partial"
      }
    }
  },
  "position": 0,
  "page": 0
}

        


          object

key value mapping

The hit matching your callback.

A hit is made of the schemaless JSON object that you stored in the index.

However, Algolia enriches them with additional fields like _highlightResult.

object: {
    field1 : "",
    field2 : "",
    [...],

    _highlightResult: {
      [...]
    }
}


          position

integer

Number of the matching object’s position in the result set (zero-based).


          page

integer

Number of the current page (zero-based). See the page search parameter.

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

Find Object | JavaScript API Client V3 (Deprecated)

About this method

Examples

Parameters

Response

JSON format

Did you find this page helpful?

On this page