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.

index.findObject(function callback)

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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
$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);

1
2
3
4
5
6
7
8
9
10
11
12
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' }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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);
});

1
2
3
4
5
6
7
8
9
10
11
12
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
})

1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
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);

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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)

1
2
3
4
5
6
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

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

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
{
  "object": {
    "firstname": "Jimmie",
    "lastname": "Barninger",
    "_highlightResult": {
      "firstname": {
        "value": "<em>Jimmie</em>",
        "matchLevel": "partial"
      },
      "lastname": {
        "value": "Barninger",
        "matchLevel": "none"
      },
      "company": {
        "value": "California <em>Paint</em> & Wlpaper Str",
        "matchLevel": "partial"
      }
    }
  },
  "position": 0,
  "page": 0
}

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

    _highlightResult: {
      [...]
    }
}