Tools

Search index toolSearch index tool

class yandexcloudmlsdk.tools.searchindex.tool.SearchIndexToolclass yandex_cloud_ml_sdk._tools.search_index.tool.SearchIndexTool

SearchIndexTool(search_index_ids: ‘tuple[str, …]’, max_num_results: ‘int | None’ = None, rephraser: ‘Rephraser | None’ = None, call_strategy: ‘CallStrategy | None’ = None)

search_index_ids: tuple[str]... ,

max_num_results: int | None = None

rephraser: Rephraser | None = None

call_strategy: CallStrategy | None = None

class yandexcloudmlsdk.tools.searchindex.rephraser.function.RephraserFunctionclass yandex_cloud_ml_sdk._tools.search_index.rephraser.function.RephraserFunction

Function for creating Rephraser object, which incapsulating rephrasing settings.

__call__(model_name, *, model_version='latest')

Creates a Rephraser object, which incapsulating rephrasing settings.

Parameters	model_name (str | Literal[True] | ~yandex_cloud_ml_sdk._tools.search_index.rephraser.model.Rephraser) – Model ID used for model uri definition in a resulting Rephraser object. It is handled differently depending on the type and format of the input value: If model_name includes :// substring, it would be used unchanged. Otherwise if model_name is a string, it would be used in gpt://<folder_id>/<model_name>/<model_version> template. If model_name is a True, it would be transformed into default value gpt://<folder_id>/rephraser/<model_version> If model_name is a Rephraser object, it would returned unchanged. model_version (str) – <model_version> value for model uri template, refer to model_name parameter documentation for details.
Returns	Rephraser object, which incapsulating rephrasing settings
Return type	Rephraser

class yandexcloudmlsdk.tools.searchindex.rephraser.model.Rephraserclass yandex_cloud_ml_sdk._tools.search_index.rephraser.model.Rephraser

Class for incapsulating rephraser settings.

Used to rewrite the last user message for search, incorporating context from the previous conversation.

property config: ConfigTypeT

configure(**kwargs)

Return type

Self

property uri: str

class yandexcloudmlsdk.tools.searchindex.callstrategy.CallStrategyclass yandex_cloud_ml_sdk._tools.search_index.call_strategy.CallStrategy

property value: Literal['always'] | FunctionDictType

Function toolFunction tool

class yandexcloudmlsdk.tools.tool.FunctionToolclass yandex_cloud_ml_sdk._tools.tool.FunctionTool

FunctionTool(name: ‘str’, description: ‘str | None’, parameters: ‘JsonSchemaType’, strict: ‘bool | None’)

name: str

description: str | None

parameters: JsonSchemaType

strict: bool | None

Generative search toolGenerative search tool

class yandexcloudmlsdk.tools.generativesearch.GenerativeSearchToolclass yandex_cloud_ml_sdk._tools.generative_search.GenerativeSearchTool

A generative search tool that can be called by LLMs/Assistants models.

To learn more about generative search itself, refer to generative search documentation

Objects of this class could be used in any place which requires BaseTool instance, but not every place/feature supports all of the tool types.

description: str = ''

Description of tool instance which also instructs model when to call it.

enable_nrfm_docs: bool | None = None

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.

fix_misspell: bool | None = None

tells to backend to fix or not to fix misspels in queries.

host: tuple[str, ...] | None = None

Parameter for limiting search to specific location or list of hosts.

search_filters: tuple[FilterType, ...] | None = None

allows to limit search results with additional filters.

site: tuple[str, ...] | None = None

Parameter for limiting search to specific location or list of sites.

url: tuple[str, ...] | None = None

Parameter for limiting search to specific location or list of urls.