API Reference / API Methods / Search / Find answers

Nov. 12, 2020

Find Answers

Required API Key: any key with the nluReadAnswers ACL

Method signature

Not implemented yet.

Not implemented yet.

index.findAnswers(
   query: string,
   queryLanguages: string[],
   {
     attributesForPrediction: string[],
     nbHits: number,
     threshold: number,
     params: object
   }
 )

Not implemented yet.

index.findAnswers(
  for query: AnswersQuery,
  requestOptions: RequestOptions? = nil,
  completion: Result<SearchResponse> -> Void
)

index.findAnswers(
    answersQuery: AnswersQuery,
    requestOptions: RequestOptions? = null,
): ResponseSearch

Not implemented yet.

Not implemented yet.

Not implemented yet.

Not implemented yet.

Not implemented yet.

See code examples

About this method

You are currently reading the JavaScript API client v4 documentation. Check our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

You are currently reading the Ruby API client v2 documentation. Check our migration guide to learn how to upgrade from v1 to v2. You can still access the v1 documentation.

Search your index with natural-language understanding (NLU) AI using Algolia Answers.

Examples

Copy

1
// Not implemented yet

1
2
3
4
5
6
7
8
index.findAnswers(
  'when do babies s?tart learning',
  ['en'],
  {
    attributesForPrediction: ['description', 'title', 'transcript'],
    nbHits: 2
  }
)

1
2
3
4
5
6
7
8
9
let query = AnswersQuery(query: "when do babies start learning?")
  .set(\.queryLanguages, to: [.english])
  .set(\.attributesForPrediction, to: ["description", "title", "transcript"])
  .set(\.nbHits, to: 2)
index.findAnswers(for: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
val query = AnswersQuery(
    query = "when do babies start learning?",
    queryLanguages = listOf(Language.English),
    nbHits = 2,
    attributesForPrediction = listOf(Attribute("description"), Attribute("title"), Attribute("transcript"))
)
val response = answers.findAnswers(query)

Parameters

`query`	type: object Required An AnswersQuery object.
`requestOptions`	type: key-value mapping default: No request options Optional A mapping of `requestOptions` to send along with the request.

AnswersQuery

`query`	type: string Required The query for which to retrieve results. Can’t be empty or a whitespace string.
`queryLanguages`	type: array default: ["en"] Required The languages in the query. Only supports `en`.
`attributesForPrediction`	default: ["*"] Required Attributes to use for predictions. Uses all `searchableAttributes` when left empty.
`nbHits`	type: int default: 10 Optional Number of answers to retrieve from the Answers Engine. Can’t be greater than 1000.
`threshold`	type: float default: 0.0 Optional Threshold for the answers’ confidence score. The Answers Engine returns answers with extracts that score higher than this threshold.
`params`	type: object Optional Algolia search parameters to use to fetch the hits. Can be any search parameter, except: `attributesToSnippet` `hitsPerPage` `restrictSearchableAttributes`

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
{
  "extract": "Pop quiz: When does <em>learning</em> begin? Answer: Before we are born. Science writer Annie Murphy Paul talks through new research that shows how much we learn in the womb -- from the lilt of our native language to our soon-to-be-favorite foods.",
  "score": 212.239,
  "extractAttribute": "description"
}

_answer

`extract`	string The excerpt from the hit best answering the query.
`extractAttribute`	string The attribute from which the answer was extracted. Only returned when you set `returnExtractAttribute` to `true`.
`score`	float The confidence score for this answer. Higher scores are better, with a score of `0` meaning the result is irrelevant to the query.

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 Answers

About this method

Examples

Parameters

AnswersQuery

Response

JSON format

_answer

Did you find this page helpful?

On this page