---
metadata:
  - name: generator
    content: Diplodoc Platform v5.39.1
alternate:
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/en/v2-1/ref/reference/ISuggestProvider.md
  - https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISuggestProvider.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/llms.txt

# ISuggestProvider

Интерфейс провайдера поисковых подсказок.

[Конструктор](#constructor-summary) | [Методы ](#methods-summary)

## Конструктор {#constructor-summary}

```javascript
ISuggestProvider()
```

## Методы {#methods-summary}

#|
|| **Имя** | **Возвращает** | **Описание** ||
|| [suggest](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISuggestProvider.md#suggest)([request](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISuggestProvider.md#suggest-param-request)[, [options](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/ISuggestProvider.md#suggest-param-options)]) | [vow.Promise](https://yandex.com.tr/dev/jsapi-v2-1/doc/ru/v2-1/ref/reference/vow.Promise.md) | Отправляет запрос за поисковыми подсказками. Возвращает объект Promise, который будет либо отклонён с ошибкой, либо подтверждён массивом объектов вида { displayName: "Мытищи, Московская область", value: "Россия, Московская область, Мытищи ", hl: [[0,5]] }. Поле displayName отвечает за представление топонима в удобном для чтения пользователем виде. Поле value – значение, которое необходимо подставить в поле ввода после выбора пользователем данной подсказки. Поле hl – массив диапазонов подсветки, необходимых, чтобы показать, какая именно часть результата совпала с запросом. Диапазон подсветки - массив из двух чисел: индексы начального и конечного символов диапазона. ||
|#

## Описание методов {#method_detail}

### suggest {#suggest}

```javascript
{vow.Promise} suggest(request[, options])
```

Отправляет запрос за поисковыми подсказками. Возвращает объект Promise, который будет либо отклонён с ошибкой, либо подтверждён массивом объектов вида { displayName: "Мытищи, Московская область", value: "Россия, Московская область, Мытищи ", hl: [[0,5]] }. Поле displayName отвечает за представление топонима в удобном для чтения пользователем виде. Поле value – значение, которое необходимо подставить в поле ввода после выбора пользователем данной подсказки. Поле hl – массив диапазонов подсветки, необходимых, чтобы показать, какая именно часть результата совпала с запросом. Диапазон подсветки - массив из двух чисел: индексы начального и конечного символов диапазона.

**Возвращает** объект Promise.

**Параметры:**

#|
|| **Параметр** | **Значение по умолчанию** | **Описание**  ||
|| [`request`](#suggest-param-request)[*](*star) | — | Тип: String

Строка запроса. ||
|| [`options`](#suggest-param-options) | — | Тип: Object

Опции. ||
|| [`options.boundedBy`](#suggest-param-options.boundedBy) | — | Тип: Number[][]

Прямоугольная область на карте, где предположительно находится искомый объект. Должна быть задана как массив, например [[30, 40], [50, 50]]. ||
|| [`options.results`](#suggest-param-options.results) | — | Тип: Number

Максимальное количество возвращаемых результатов. ||
|#

\* Обязательный параметр/опция.

<!-- XLIFF_FARM_NzExOWUz_CACHING -->

[*star]: Обязательный параметр.