Find Object | Ruby API Client V1 (Deprecated)

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

Required API Key: any key with the search ACL

Method signature

index.find_object { block callback }

See code examples

About this method# A

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# A

Copy

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
16
17
18
19
index.findObject(hit => hit.firstname == "Jimmie")
  .then(obj => {
    console.log(obj);
  });

// With a query
index.findObject(hit => hit.firstname == "Jimmie", {
  query: "query string"
}).then(obj => {
  console.log(obj);
});

// With a query and only in the first page
index.findObject(hit => hit.firstname == "Jimmie", {
  query: "query string",
  paginate: false
}).then(obj => {
  console.log(obj);
});

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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
let predicate: (JSON) -> Bool = { hit in
  return hit["firstname"] == "Jimmie"
}

index.findObject(matching: predicate) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

// With a query
index.findObject(matching: predicate, for: Query("query string")) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

// With a query and only in the first page
index.findObject(matching: predicate,
                 for: Query("query string"),
                 paginate: false) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

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# A

`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 request options sent along with the request.
`index` #	type: string Required Only for Scala - The name of the index to query.

Response# A

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.

Did you find this page helpful?

Find Object | Ruby API Client V1 (Deprecated)

About this method# Found an issue? Edit this guide A Edit this guide

Examples# Found an issue? Edit this guide A Edit this guide

Parameters# Found an issue? Edit this guide A Edit this guide

Response# Found an issue? Edit this guide A Edit this guide

JSON format#

On this page

About this method# A

Examples# A

Parameters# A

Response# A