Tools domain

Статья создана

Обновлена 25 сентября 2025 г.

class yandex_cloud_ml_sdk._tools.domain.Tools
Types
- class yandex_cloud_ml_sdk._tools.tool_call.ToolCall
- class yandex_cloud_ml_sdk._tools.function_call.FunctionCall

class yandex_cloud_ml_sdk._tools.domain.Tools

property function: FunctionToolsTypeT

generative_search(*, description, site=Undefined, host=Undefined, url=Undefined, enable_nrfm_docs=Undefined, search_filters=Undefined)

Creates GeberativeSearch tool which provide access to generative search by Search API for LLMs.

Not to be confused with sdk.search_api.generative. Tools domain is for creating tools for using in LLMs/Assistants and search_api domain is for using Search API directly.

To learn more about parameters and their formats and possible values, refer to generative search documentation

NB: All of the site, host, url parameters are mutually exclusive.

Parameters

site (str | Sequence[str] | Undefined) – parameter for limiting search to specific location or list of sites.
host (str | Sequence[str] | Undefined) – parameter for limiting search to specific location or list of hosts.
url (str | Sequence[str] | Undefined) – parameter for limiting search to specific location or list of URLs.
enable_nrfm_docs (bool | Undefined) – tells to backend to include or not to include pages, which are not available via direct clicks from given sites/hosts/urls to search result.
search_filters (Sequence[DateFilterType | FormatFilterType | LangFilterType] | DateFilterType | FormatFilterType | LangFilterType | Undefined) – allows to limit search results with additional filters.

>>> date_filter = {'date': '<20250101'}
>>> format_filter = {'format': 'doc'}
>>> lang_filter = {'lang': 'ru'}
>>> tool = sdk.tools.generative_search(
...     search_filters=[date_filter, format_filter, lang_filter],
...     description="description when model should call a tool"
... )

description (str)

Return type

GenerativeSearchTool

property rephraser: RephraserFunction

search_index(indexes, *, max_num_results=Undefined, rephraser=Undefined, call_strategy=Undefined)

Creates SearchIndexTool (not to be confused with SearchIndex/AsyncSearchIndex).

Parameters

indexes (str | BaseSearchIndex | Iterable[BaseSearchIndex] | Iterable[str]) – parameter takes BaseSearchIndex, string with search index id, or a list of this values in any combination.
max_num_results (int | Undefined) – the maximum number of results to return from the search. Fewer results may be returned if necessary to fit within the prompt’s token limit. This ensures that the combined prompt and search results do not exceed the token constraints.
rephraser (str | Literal[True] | ~yandex_cloud_ml_sdk._tools.search_index.rephraser.model.Rephraser | ~yandex_cloud_ml_sdk._types.misc.Undefined) – setting for rephrasing user queries; refer to Rephraser documentation for details.
call_strategy (Literal['always'] | ~yandex_cloud_ml_sdk._types.tools.function.FunctionDictType | ~yandex_cloud_ml_sdk._tools.search_index.call_strategy.CallStrategy | ~yandex_cloud_ml_sdk._types.misc.Undefined)