Метод lookup
Осуществляет поиск слова или фразы в словаре и возвращает автоматически сформированную словарную статью.
Описание
DicResult lookup(string key, string text, string lang, string ui, int flags);
Входные параметры
Входные параметры могут передаваться либо с помощью HTTP GET-запроса (см. пример), либо с помощью HTTP POST-запроса, где параметры передаются в body
HTTP-запроса.
Пример запроса:
XML-интерфейс:
https://dictionary.yandex.net/api/v1/dicservice/lookup?key=API-ключ&lang=en-ru&text=time
JSON-интерфейс:
https://dictionary.yandex.net/api/v1/dicservice.json/lookup?key=API-ключ&lang=en-ru&text=time
JSONP-интерфейс (для функции myCallback):
https://dictionary.yandex.net/api/v1/dicservice.json/lookup?key=API-ключ&lang=en-ru&text=time&callback=myCallback
Список входных параметров.
Параметр | Тип | Описание |
---|---|---|
Обязательные | ||
key | string | API-ключ. Получите бесплатный API-ключ на этой странице. |
lang | string | Направление перевода (например, "en-ru"). Задается в виде пары кодов языков, перечисленных через дефис. Например, "en-ru" задает перевод с английского на русский. Совет. Сервис работает не только с переводными словарями. Например, вы можете указать направление "ru-ru" или "en-en" и получить все возможные значения искомого слова на русском или английском языке. |
text | string | Слово или фраза, которые требуется найти в словаре. |
Необязательные | ||
ui | string | Язык интерфейса пользователя, на котором будут отображаться названия частей речи в словарной статье. Возможные значения:
|
flags | int | Опции поиска (битовая маска флагов). Возможные значения:
|
Параметр | Тип | Описание |
---|---|---|
Обязательные | ||
key | string | API-ключ. Получите бесплатный API-ключ на этой странице. |
lang | string | Направление перевода (например, "en-ru"). Задается в виде пары кодов языков, перечисленных через дефис. Например, "en-ru" задает перевод с английского на русский. Совет. Сервис работает не только с переводными словарями. Например, вы можете указать направление "ru-ru" или "en-en" и получить все возможные значения искомого слова на русском или английском языке. |
text | string | Слово или фраза, которые требуется найти в словаре. |
Необязательные | ||
ui | string | Язык интерфейса пользователя, на котором будут отображаться названия частей речи в словарной статье. Возможные значения:
|
flags | int | Опции поиска (битовая маска флагов). Возможные значения:
|
Возвращает
В XML-интерфейсе возвращает структуру DicResult
, которая содержит словарную статью, автоматически сформированную по результатам поиска. Например:
<DicResult>
<head/>
<def pos="noun" ts="taɪm">
<text>time</text>
<tr pos="существительное">
<text>время</text>
<syn>
<text>раз</text>
</syn>
<syn>
<text>тайм</text>
</syn>
<mean>
<text>timing</text>
</mean>
<mean>
<text>fold</text>
</mean>
<mean>
<text>half</text>
</mean>
<ex>
<text>prehistoric time</text>
<tr>
<text>доисторическое время</text>
</tr>
</ex>
<ex>
<text>hundredth time</text>
<tr>
<text>сотый раз</text>
</tr>
</ex>
<ex>
<text>time-slot</text>
<tr>
<text>тайм-слот</text>
</tr>
</ex>
</tr>
</def>
</DicResult>
Элемент | Описание |
---|---|
head | Заголовок результата (не используется). |
def | Массив словарных статей. В атрибуте ts может указываться транскрипция искомого слова. |
tr | Массив переводов. |
syn | Массив синонимов. |
mean | Массив значений. |
ex | Массив примеров. |
Элемент | Описание |
---|---|
head | Заголовок результата (не используется). |
def | Массив словарных статей. В атрибуте ts может указываться транскрипция искомого слова. |
tr | Массив переводов. |
syn | Массив синонимов. |
mean | Массив значений. |
ex | Массив примеров. |
Атрибут | Описание |
---|---|
text | Текст статьи, перевода или синонима (обязательный). |
num | Число (для имен существительных). Возможные значения:
|
pos | Часть речи (может отсутствовать). |
gen | Род существительного для тех языков, где это актуально (может отсутствовать). |
Атрибут | Описание |
---|---|
text | Текст статьи, перевода или синонима (обязательный). |
num | Число (для имен существительных). Возможные значения:
|
pos | Часть речи (может отсутствовать). |
gen | Род существительного для тех языков, где это актуально (может отсутствовать). |
Код | Значение | Описание |
---|---|---|
ERR_OK | 200 | Операция выполнена успешно. |
ERR_KEY_INVALID | 401 | Ключ API невалиден. |
ERR_KEY_BLOCKED | 402 | Ключ API заблокирован. |
ERR_DAILY_REQ_LIMIT_EXCEEDED | 403 | Превышено суточное ограничение на количество запросов. |
ERR_TEXT_TOO_LONG | 413 | Превышен максимальный размер текста. |
ERR_LANG_NOT_SUPPORTED | 501 | Заданное направление перевода не поддерживается. |
Код | Значение | Описание |
---|---|---|
ERR_OK | 200 | Операция выполнена успешно. |
ERR_KEY_INVALID | 401 | Ключ API невалиден. |
ERR_KEY_BLOCKED | 402 | Ключ API заблокирован. |
ERR_DAILY_REQ_LIMIT_EXCEEDED | 403 | Превышено суточное ограничение на количество запросов. |
ERR_TEXT_TOO_LONG | 413 | Превышен максимальный размер текста. |
ERR_LANG_NOT_SUPPORTED | 501 | Заданное направление перевода не поддерживается. |
В JSON-интерфейсе вместо XML-элементов возвращаются JavaScript-объекты с теми же именами и семантикой:
{ "head": {},
"def": [
{ "text": "time", "pos": "noun",
"tr": [
{ "text": "время", "pos": "существительное",
"syn": [
{ "text": "раз" },
{ "text": "тайм" }
],
"mean": [
{ "text": "timing" },
{ "text": "fold" },
{ "text": "half"}
],
"ex" : [
{ "text": "prehistoric time",
"tr": [
{ "text": "доисторическое время" }
]
},
{ "text": "hundredth time",
"tr": [
{ "text": "сотый раз" }
]
},
{ "text": "time-slot",
"tr": [
{ "text": "тайм-слот" }
]
}
]
}
]
}
]
}
В JSONP-интерфейсе те же самые JavaScript-объекты возвращаются в callback-функции (например, myCallback):
myCallback({
"head": {},
"def": [
{ "text": "time", "pos": "noun",
"tr": [
{ "text": "время", "pos": "существительное",
"syn": [
{ "text": "раз" },
{ "text": "тайм" }
],
"mean": [
{ "text": "timing" },
{ "text": "fold" },
{ "text": "half"}
],
"ex" : [
{ "text": "prehistoric time",
"tr": [
{ "text": "доисторическое время" }
]
},
{ "text": "hundredth time",
"tr": [
{ "text": "сотый раз" }
]
},
{ "text": "time-slot",
"tr": [
{ "text": "тайм-слот" }
]
}
]
}
]
}
]
})