suggest
Описание
Операция Suggest находит адреса или кандидаты мест на основе неполных или неправильно написанных запросов. Затем вы выбираете лучший запрос для отправки на основе полученных результатов.
См. также: Документацию AWS API
Синтаксис
suggest
--query-text <value>
[--max-results <value>]
[--max-query-refinements <value>]
[--bias-position <value>]
[--filter <value>]
[--additional-features <value>]
[--language <value>]
[--political-view <value>]
[--intended-use <value>]
[--key <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
Параметры
--query-text (строка)
--max-results (целое число)
--max-query-refinements (целое число)
--bias-position (список)
Позиция в долготе и широте, к которой результаты должны быть близки. Как правило, результаты мест, возвращаемые, ранжируются выше, чем ближе они находятся к этой позиции. Сохраняется в [lng, lat] и в формате WSG84.
Примечание
ПоляBiasPosition , FilterBoundingBox и FilterCircle взаимоисключающие.(двойное)
Синтаксис:
double double ...
--filter (структура)
Структура, содержащая набор свойств включения/исключения, которыми должны обладать результаты, чтобы быть возвращены как результат.
BoundingBox -> (список)
Охватывающая прямоугольная область, представляющая геометрическую форму (область или линию), которую охватывает каждый отдельный результат.
Прямоугольная область определяется как набор из 4 координат: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
(двойное)
Circle -> (структура)
Circle, в котором должны находиться все результаты.
Center -> (список)
Центральная позиция в долготе и широте FilterCircle.
(двойное)
Radius -> (длинное)
FilterCircle в метрах.IncludeCountries -> (список)
Список стран, в которых должны находиться все результаты. Страны представлены либо кодами из двух, либо из трех символов.
(строка)
Сокращенный синтаксис:
BoundingBox=double,double,Circle={Center=[double,double],Radius=long},IncludeCountries=string,string
Синтаксис JSON:
{
"BoundingBox": [double, ...],
"Circle": {
"Center": [double, ...],
"Radius": long
},
"IncludeCountries": ["string", ...]
}
--additional-features (список)
Список необязательных дополнительных параметров, таких как часовой пояс, которые могут быть запрошены для каждого результата.
(строка)
Синтаксис:
"string" "string" ...
Where valid values are:
Core
TimeZone
Phonemes
Access
--language (строка)
--political-view (строка)
--intended-use (строка)
Указывает, будут ли результаты сохранены. По умолчанию значение равно SingleUse, если не указано иное.
Возможные значения:
SingleUse
--key (строка)
--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON следует формату, предоставленному --generate-cli-skeleton. Если другие аргументы предоставляются в командной строке, эти значения переопределяют значения, предоставленные в JSON. Невозможно передавать произвольные двоичные значения, используя значение, предоставленное в JSON, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.
--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод без отправки API-запроса. Если предоставлено без значения или со значением input, выводит пример ввода JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, выведет пример ввода YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, проверит входные данные команды и вернет пример выходного JSON для этой команды. Сгенерированный JSON-каркас не является стабильным между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном JSON-каркасе.
Глобальные параметры
--debug (логическое)
Включить отладку.
--endpoint-url (строка)
Переопределить URL по умолчанию команды заданным URL.
--no-verify-ssl (логическое)
По умолчанию AWS CLI использует SSL при взаимодействии с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять SSL-сертификаты. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.
--no-paginate (логическое)
Отключить автоматическую постраничную навигацию. Если автоматическая постраничная навигация отключена, AWS CLI выполнит только один вызов для первой страницы результатов.
--output (строка)
Стиль форматирования для вывода команды.
- json
- текст
- таблица
- yaml
- yaml-потоковый
--query (строка)
Запрос JMESPath для использования при фильтрации данных ответа.
--profile (строка)
Использовать определенный профиль из файла учетных данных.
--region (строка)
Использовать определенный регион. Переопределяет настройки конфигурации/среды.
--version (строка)
Отобразить версию этого инструмента.
--color (строка)
Включить/выключить цветной вывод.
- вкл
- выкл
- авто
--no-sign-request (логическое)
Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.
--ca-bundle (строка)
Набор сертификатов CA для использования при проверке SSL-сертификатов. Переопределяет настройки конфигурации/среды.
--cli-read-timeout (целое число)
Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет выполняться в блочном режиме без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-connect-timeout (целое число)
Максимальное время подключения к сокету в секундах. Если значение установлено в 0, подключение к сокету будет выполняться в блочном режиме без таймаута. Значение по умолчанию составляет 60 секунд.
--cli-binary-format (строка)
Стиль форматирования, используемый для двоичных блоков. По умолчанию используется формат base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как строка, закодированная в base64. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны передаваться буквально. При предоставлении содержимого из файла, которое сопоставляется с двоичным блоком, fileb:// всегда будет рассматриваться как двоичный и использовать содержимое файла напрямую независимо от значения cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для настроенного cli-binary-format.
- base64
- raw-in-base64-out
--no-cli-pager (логическое)
Отключить вывод AWS CLI.
--cli-auto-prompt (логическое)
Автоматически запросить параметры ввода CLI.
--no-cli-auto-prompt (логическое)
Отключить автоматический запрос параметров ввода CLI.
Вывод
PricingBucket -> (строка)
Ценовой сегмент, за который взимается оплата при запросе.
Дополнительную информацию о ценах можно найти на странице Amazon Location Service Pricing .
ResultItems -> (список)
Список мест или результатов, возвращенных по запросу.
(структура)
Элемент результата из предложенного запроса.
Title -> (строка)
SuggestResultItemType -> (строка)
Place -> (структура)
Предложенное место по его уникальному идентификатору.
PlaceId -> (строка)
PlaceId места, для которого вы хотите получить информацию.PlaceType -> (строка)
PlaceType — это категория, к которой должно принадлежать результативное место.Address -> (структура)
Адрес места.
Label -> (строка)
Country -> (структура)
Компонент страны в адресе.
Code2 -> (строка)
Code3 -> (строка)
Name -> (строка)
Region -> (структура)
Регион или штат, в котором должны присутствовать результаты.
Пример: North Rhine-Westphalia .
Code -> (строка)
Сокращенное обозначение штата, провинции или региона страны.
Пример: BC .
Name -> (строка)
Название штата, провинции или региона страны.
Пример: British Columbia .
SubRegion -> (структура)
Подрегион или округ, в котором должны присутствовать результаты.
Code -> (строка)
Name -> (строка)
Locality -> (строка)
Населенный пункт или город в адресе.
Пример: Vancouver .
District -> (строка)
SubDistrict -> (строка)
Подразделение округа.
Пример: Minden-Lübbecke .
PostalCode -> (строка)
Block -> (строка)
Название квартала.
Пример: Sunny Mansion 203 block: 2 Chome
SubBlock -> (строка)
Название подквартала.
Пример: Sunny Mansion 203 sub-block: 4
Intersection -> (список)
Название улиц на перекрестке.
Пример: ["Friedrichstraße","Unter den Linden"]
(строка)
Street -> (строка)
StreetComponents -> (список)
Компоненты улицы.
Пример: Younge из «улицы Younge».
(структура)
Компоненты улицы.
BaseName -> (строка)
Основная часть названия улицы.
Пример: Younge из «улицы Younge».
Type -> (строка)
Тип улицы в названии улицы.
Пример: “avenue" .
TypePlacement -> (строка)
TypeSeparator -> (строка)
Prefix -> (строка)
Префикс — это направленное обозначение, которое предшествует, но не включается в основное название дороги.
Пример: E для Востока.
Suffix -> (строка)
Суффикс — это направленное обозначение, которое следует за, но не включается в основное название дороги.
Пример W для Запада.
Direction -> (строка)
Language -> (строка)
AddressNumber -> (строка)
Building -> (строка)
Position -> (список)
Положение в долготе и широте.
(вещественное число)
Distance -> (целое число)
MapView -> (список)
Прямоугольник, охватывающий геометрическую форму (область или линию), которую охватывает отдельный результат.
Прямоугольник, образованный, определяется как набор 4 координат: [{westward lng}, {southern lat}, {eastward lng}, {northern lat}]
(вещественное число)
Categories -> (список)
Категории результатов, к которым результаты должны принадлежать.
(структура)
Категория возвращенного Place.
Id -> (строка)
Name -> (строка)
LocalizedName -> (строка)
Primary -> (логическое)
FoodTypes -> (список)
Список типов блюд, предлагаемых этим результатом.
(структура)
Список типов Food, предлагаемых этим результатом.
LocalizedName -> (строка)
Id -> (строка)
Primary -> (логическое)
BusinessChains -> (список)
Бренды, связанные с местом.
(структура)
Бренд — это группа предприятий, принадлежащих одному бренду. Например, 7-11 .
Name -> (строка)
Id -> (строка)
AccessPoints -> (список)
Положение точки доступа, представленное долготой и широтой.
(структура)
Положение точки доступа, представленное долготой и широтой для транспортного средства.
Position -> (список)
Положение в долготе и широте.
(вещественное число)
AccessRestrictions -> (список)
Указывает известные ограничения доступа к точке доступа для транспортных средств. Индекс соответствует точке доступа и указывает, существует ли какой-либо тип ограничения доступа через эту точку.
(структура)
Указывает, является ли место доступа ограниченным. Индекс соответствует точке доступа и указывает, существует ли какой-либо тип ограничения доступа через эту точку.
Restricted -> (логическое)
Categories -> (список)
Категории результатов, к которым результаты должны принадлежать.
(структура)
Категория возвращенного Place.
Id -> (строка)
Name -> (строка)
LocalizedName -> (строка)
Primary -> (логическое)
TimeZone -> (структура)
Временная зона местоположения.
Name -> (строка)
Offset -> (строка)
OffsetSeconds -> (целое число)
PoliticalView -> (строка)
Phonemes -> (структура)
Как произносятся различные компоненты адреса результата на разных языках.
Title -> (список)
Список PhonemeTranscription. См. PhonemeTranscription для полей.
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
Address -> (структура)
Как произносится адрес.
Country -> (список)
Код страны в формате alpha-2 или alpha-3, в котором будут представлены результаты.
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
Region -> (список)
Как произносится регион или штат, в котором должны присутствовать результаты.
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
SubRegion -> (список)
Как произносится подрегион или округ, в котором должны присутствовать результаты.
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
Locality -> (список)
Как произносится город или населенный пункт, в котором должны присутствовать результаты.
Пример: Vancouver .
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
District -> (список)
Как произносится район или округ города, в котором должны присутствовать результаты.
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
SubDistrict -> (список)
Как произносится подрайон или подразделение города, в котором должны присутствовать результаты.
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
Block -> (список)
Как произносится название квартала.
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
SubBlock -> (список)
Как произносится название подквартала.
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
Street -> (список)
Как произносится название улицы, в которой должны быть результаты.
(структура)
Как произносится тот или иной компонент адреса или места.
Value -> (строка)
Language -> (строка)
Preferred -> (булево)
Query -> (структура)
Предложенные результаты запроса.
QueryId -> (строка)
QueryType -> (строка)
Highlights -> (структура)
Описывает, как части элемента ответа соответствуют входному запросу, возвращая части ответа, которые соответствуют терминам входного запроса.
Title -> (список)
Указывает начальный и конечный индекс заголовка в текстовом запросе, который соответствует найденному заголовку.
(структура)
Описывает, как части ответа результата соответствуют входному запросу.
StartIndex -> (целое число)
EndIndex -> (целое число)
Value -> (строка)
Address -> (структура)
Адрес места.
Label -> (список)
Указывает начальный и конечный индексы мест в результате, которые были идентифицированы как соответствующие текстовому запросу. Этот результат полезен для выделения результатов, где пользовательский запрос напрямую совпадает, что облегчает выбор правильного результата из списка для конечного пользователя.
(структура)
Описывает, как части ответа результата соответствуют входному запросу.
StartIndex -> (целое число)
EndIndex -> (целое число)
Value -> (строка)
QueryRefinements -> (список)
Максимальное количество терминов запроса, которые будут возвращены для использования с запросом поиска текста.
(структура)
Предложения для уточнения отдельных терминов запроса. Предложения возвращаются в виде объектов, которые указывают термин, предполагаемое замещение и его индекс в запросе.
RefinedTerm -> (строка)
OriginalTerm -> (строка)
StartIndex -> (целое число)
EndIndex -> (целое число)
© Copyright 2025, Amazon Web Services. Created using Sphinx.