__call__(*, site=Undefined, host=Undefined, url=Undefined, fix_misspell=Undefined, enable_nrfm_docs=Undefined, search_filters=Undefined)

Creates generative search object which provides methods for invoking generative search.

Not to be confused with sdk.tools.generative_search. 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.
fix_misspell (bool | Undefined) – tells to backend to fix or not to fix misspels in queries.
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'}
>>> search = sdk.search_api.generative(search_filters=[date_filter, format_filter, lang_filter])

Return type

GenerativeSearchTypeT

property available_formats

class yandex_cloud_ml_sdk._search_api.generative.generative.GenerativeSearch

Generative search class which provides concrete methods for working with Search API and incapsulates search setting.

run(request, *, timeout=60)

Run a search query with given request and search settings of this generative search object.

To change initial search settings use .configure method:

>>> search = sdk.search_api.generative(site="site")
>>> search = search.configure(site="other_site")

Parameters

request (TextMessage | TextMessageDict | TextMessageProtocol | str | Iterable[TextMessage | TextMessageDict | TextMessageProtocol | str]) – search request, which could be either standalone request (message) or a list of messages, which represents a context of conversation with a model.

Also message could be one of the data formats:

"string" – in case of string input message will be passed to a model with a role="user";
{"text": "text", "role": "user"} – in case of dict input, it will be passed with corresponding "text" and "role" dict keys;
MessageObject – you could also pass any object which have a text: str and role: str attributes, allowing to reuse various result object, for example object you getting from compltions model run or result object from generative search itself;
["string"/dict/object] – list or any other sequence of any above described formats.
timeout (float) – timeout, or the maximum time to wait for the request to complete in seconds.

Return type

GenerativeSearchResult

as_tool(description)

Converts generative search instance to GenerativeSearchTool object which is eligible to use as tools in LLMs/Assistants.

Parameters	description (str) – description of tool instance which also instructs model when to call it.
Return type	GenerativeSearchTool

property config: ConfigTypeT

configure(*, site=Undefined, host=Undefined, url=Undefined, fix_misspell=Undefined, enable_nrfm_docs=Undefined, search_filters=Undefined)

Returns the new object with config fields overrode by passed values.

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 and using one of them is mandatory.

Parameters

site (str | Sequence[str] | Undefined | None) – parameter for limiting search to specific location or list of sites.
host (str | Sequence[str] | Undefined | None) – parameter for limiting search to specific location or list of hosts.
url (str | Sequence[str] | Undefined | None) – parameter for limiting search to specific location or list of URLs.
fix_misspell (bool | Undefined | None) – tells to backend to fix or not to fix misspels in queries.
enable_nrfm_docs (bool | Undefined | 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.
search_filters (Sequence[DateFilterType | FormatFilterType | LangFilterType] | DateFilterType | FormatFilterType | LangFilterType | Undefined | None) – allows to limit search results with additional filters.

>>> date_filter = {'date': '<20250101'}
>>> format_filter = {'format': 'doc'}
>>> lang_filter = {'lang': 'ru'}
>>> search = sdk.search_api.generative(search_filters=[date_filter, format_filter, lang_filter])

Return type

Self

property uri: str

Web search

class yandex_cloud_ml_sdk._search_api.web.function.WebSearchFunction

Web search function for creating search object which provides methods for invoking web search.

__call__(search_type, *, family_mode=Undefined, fix_typo_mode=Undefined, localization=Undefined, sort_order=Undefined, sort_mode=Undefined, group_mode=Undefined, groups_on_page=Undefined, docs_in_group=Undefined, max_passages=Undefined, region=Undefined, user_agent=Undefined, metadata=Undefined)

Creates web search object which provides methods for web search.

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

Parameters

search_type (SearchType | UnknownEnumValue[SearchType] | str | int) – Search type.
family_mode (FamilyMode | UnknownEnumValue[FamilyMode] | str | int | Undefined) – Results filtering.
fix_typo_mode (FixTypoMode | UnknownEnumValue[FixTypoMode] | str | int | Undefined) – Search query typo correction setting
localization (Localization | UnknownEnumValue[Localization] | str | int | Undefined) – Search response notifications language. Affects the text in the found-docs-human tag and error messages
sort_order (SortOrder | UnknownEnumValue[SortOrder] | str | int | Undefined) – Search results sorting order
sort_mode (SortMode | UnknownEnumValue[SortMode] | str | int | Undefined) – Search results sorting mode rule
group_mode (GroupMode | UnknownEnumValue[GroupMode] | str | int | Undefined) – Result grouping method.
groups_on_page (int | Undefined) – Maximum number of groups that can be returned per page.
docs_in_group (int | Undefined) – Maximum number of documents that can be returned per group.
max_passages (int | Undefined) – Maximum number of passages that can be used when generating a document.
region (str | Undefined) – Search country or region ID that affects the document ranking rules.
user_agent (str | Undefined) – String containing the User-Agent header. Use this parameter to have your search results optimized for a specific device and browser, including mobile search results.
metadata (Mapping[str, str] | Undefined)

Return type

WebSearchTypeT

class yandex_cloud_ml_sdk._search_api.web.web.WebSearch

Web search class which provides concrete methods for working with Web Search API and incapsulates search setting.

property config: ConfigTypeT

configure(*, search_type=Undefined, family_mode=Undefined, fix_typo_mode=Undefined, localization=Undefined, sort_order=Undefined, sort_mode=Undefined, group_mode=Undefined, groups_on_page=Undefined, docs_in_group=Undefined, max_passages=Undefined, region=Undefined, user_agent=Undefined, metadata=Undefined)

Returns the new object with config fields overrode by passed values.

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

Parameters

search_type (SearchType | UnknownEnumValue[SearchType] | str | int | Undefined | None) – Search type.
family_mode (FamilyMode | UnknownEnumValue[FamilyMode] | str | int | Undefined | None) – Results filtering.
fix_typo_mode (FixTypoMode | UnknownEnumValue[FixTypoMode] | str | int | Undefined | None) – Search query typo correction setting
localization (Localization | UnknownEnumValue[Localization] | str | int | Undefined | None) – Search response notifications language. Affects the text in the found-docs-human tag and error messages
sort_mode (SortMode | UnknownEnumValue[SortMode] | str | int | Undefined | None) – Search results sorting mode rule
sort_order (SortOrder | UnknownEnumValue[SortOrder] | str | int | Undefined | None) – Search results sorting order
group_mode (GroupMode | UnknownEnumValue[GroupMode] | str | int | Undefined | None) – Result grouping method.
groups_on_page (int | Undefined | None) – Maximum number of groups that can be returned per page.
docs_in_group (int | Undefined | None) – Maximum number of documents that can be returned per group.
max_passages (int | Undefined | None) – Maximum number of passages that can be used when generating a document.
region (str | Undefined | None) – Search country or region ID that affects the document ranking rules.
user_agent (str | Undefined | None) – String containing the User-Agent header. Use this parameter to have your search results optimized for a specific device and browser, including mobile search results.
metadata (Mapping[str, str] | Undefined | None)

Return type

Self

property uri: str

run(query: str, *, format: Literal['parsed'] = 'parsed', page: int = 0, timeout: float = 60) → WebSearchResult

run(query: str, *, format: Literal['xml', 'html'], page: int = 0, timeout: float = 60) → bytes

Run a search query with given query and search settings of this web search object.

To change initial search settings use .configure method:

>>> search = sdk.search_api.web(search_type='BE')
>>> search = search.configure(search_type='RU')

Parameters

query – Search query text.
format – With default parsed value call returns a parsed Yandex Cloud ML SDK object; with other values method returns a raw bytes string.
page – Requested page number.
timeout – Timeout, or the maximum time to wait for the request to complete in seconds.

Returns

Parsed search results object or bytes string depending on format parameter.

run_deferred(query: str, *, format: Literal['parsed'] = 'parsed', page: int = 0, timeout: float = 60) → Operation[WebSearchResult]

run_deferred(query: str, *, format: Literal['xml', 'html'], page: int = 0, timeout: float = 60) → Operation[bytes]

Run a deferred search query with given query and search settings of this web search object.

To change initial search settings use .configure method:

>>> search = sdk.search_api.web(search_type='BE')
>>> search = search.configure(search_type='RU')

Parameters

query – Search query text.
format – With default parsed value call returns an operation with parsed Yandex Cloud ML SDK return; with other values method returns an operation with raw bytes string return.
page – Requested page number.
timeout – Timeout, or the maximum time to wait for the request to complete in seconds.

Returns

Operation with parsed search results object or bytes string return depending on format parameter.

class yandex_cloud_ml_sdk._search_api.web.result.WebSearchResult

A class representing the partially parsed result of a Web search request with XML format.

next_page(*, timeout=None)

Run a web search request with previous search parameters except page number being increment by one.

Parameters	timeout (float \| None) – Timeout, or the maximum time to wait for the request to complete in seconds; if not given, initial timeout value from original search request are being used.
Return type	Self

next_page_deferred(*, timeout=None)

Launch a deferred web search request with previous search parameters except page number being increment by one.

Parameters	timeout (float \| None) – Timeout, or the maximum time to wait for the request to complete in seconds; if not given, initial timeout value from original search request are being used.
Return type	Operation[WebSearchResult]

count(value) → integer -- return number of occurrences of value

property docs: tuple[XMLSearchDocumentTypeT]... ,

Returns all documents within search response.

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

xml: bytes

Non-parsed XML result of search request.

groups: tuple[SearchGroup[XMLSearchDocumentTypeT]... ,]

Parsed values of tags within the response.

page: int

Returned search page number.

Image search

class yandex_cloud_ml_sdk._search_api.image.function.ImageSearchFunction

Image search function for creating search object which provides methods for invoking image search.

__call__(search_type, *, family_mode=Undefined, fix_typo_mode=Undefined, format=Undefined, size=Undefined, orientation=Undefined, color=Undefined, site=Undefined, docs_on_page=Undefined, user_agent=Undefined)

Creates image search object which provides methods for image search.

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

Parameters

search_type (SearchType | UnknownEnumValue[SearchType] | str | int) – Search type.
family_mode (FamilyMode | UnknownEnumValue[FamilyMode] | str | int | Undefined) – Results filtering.
fix_typo_mode (FixTypoMode | UnknownEnumValue[FixTypoMode] | str | int | Undefined) – Search query typo correction setting.
format (ImageFormat | UnknownEnumValue[ImageFormat] | str | int | Undefined) – Searching for images in a particular format.
size (ImageSize | UnknownEnumValue[ImageSize] | str | int | Undefined) – Searching for images of a particular size.
orientation (ImageOrientation | UnknownEnumValue[ImageOrientation] | str | int | Undefined) – Searching for images with a particular orientation.
color (ImageColor | UnknownEnumValue[ImageColor] | str | int | Undefined) – Searching for images containing a particular color.
site (str | Undefined) – Number of results per search result page.
docs_on_page (int | Undefined) – Number of results per search result page.
user_agent (str | Undefined) – String containing the User-Agent header. Use this parameter to have your search results optimized for a specific device and browser, including mobile search results.

Return type

ImageSearchTypeT

class yandex_cloud_ml_sdk._search_api.image.image.ImageSearch

Image search class which provides concrete methods for working with Image Search API and incapsulates search setting.

property config: ConfigTypeT

configure(*, search_type=Undefined, family_mode=Undefined, fix_typo_mode=Undefined, format=Undefined, size=Undefined, orientation=Undefined, color=Undefined, site=Undefined, docs_on_page=Undefined, user_agent=Undefined)

Returns the new object with config fields overrode by passed values.

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

Parameters

search_type (SearchType | UnknownEnumValue[SearchType] | str | int | Undefined) – Search type.
family_mode (FamilyMode | UnknownEnumValue[FamilyMode] | str | int | Undefined | None) – Results filtering.
fix_typo_mode (FixTypoMode | UnknownEnumValue[FixTypoMode] | str | int | Undefined | None) – Search query typo correction setting
format (ImageFormat | UnknownEnumValue[ImageFormat] | str | int | Undefined | None) – Searching for images in a particular format.
size (ImageSize | UnknownEnumValue[ImageSize] | str | int | Undefined | None) – Searching for images of a particular size.
orientation (ImageOrientation | UnknownEnumValue[ImageOrientation] | str | int | Undefined | None) – Searching for images with a particular orientation.
color (ImageColor | UnknownEnumValue[ImageColor] | str | int | Undefined | None) – Searching for images containing a particular color.
site (str | Undefined | None) – Number of results per search result page.
docs_on_page (int | Undefined | None) – Number of results per search result page.
user_agent (str | Undefined | None) – String containing the User-Agent header. Use this parameter to have your search results optimized for a specific device and browser, including mobile search results.

Return type

Self

property uri: str

run(query: str, *, format: Literal['parsed'] = 'parsed', page: int = 0, timeout: float = 60) → ImageSearchResult

run(query: str, *, format: Literal['xml'], page: int = 0, timeout: float = 60) → bytes

Run a search query with given query and search settings of this image search object.

To change initial search settings use .configure method:

>>> search = sdk.search_api.image(search_type='BE')
>>> search = search.configure(search_type='RU')

Parameters

query – Search query text.
format – With default parsed value call returns a parsed Yandex Cloud ML SDK object; with other values method returns a raw bytes string.
page – Requested page number.
timeout – Timeout, or the maximum time to wait for the request to complete in seconds.

Returns

Parsed search results object or bytes string depending on format parameter.

class yandex_cloud_ml_sdk._search_api.image.result.ImageSearchResult

A class representing the partially parsed result of a Image search request with XML format.

next_page(*, timeout=None)

Run a image search request with previous search parameters except page number being increment by one.

Parameters	timeout (float \| None) – Timeout, or the maximum time to wait for the request to complete in seconds; if not given, initial timeout value from original search request are being used.
Return type	Self

count(value) → integer -- return number of occurrences of value

property docs: tuple[XMLSearchDocumentTypeT]... ,

Returns all documents within search response.

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

xml: bytes

Non-parsed XML result of search request.

groups: tuple[SearchGroup[XMLSearchDocumentTypeT]... ,]

Parsed values of tags within the response.

page: int

Returned search page number.

Search by image

class yandex_cloud_ml_sdk._search_api.by_image.function.ByImageSearchFunction

ByImage search function for creating search object which provides methods for invoking by_image search.

__call__(*, family_mode=Undefined, site=Undefined)

Creates by_image search object which provides methods for search by image.

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

Parameters

family_mode (FamilyMode | UnknownEnumValue[FamilyMode] | str | int | Undefined) – Results filtering.
site (str | Undefined) – Restricts the search to the specific website.

Return type

ByImageSearchTypeT

class yandex_cloud_ml_sdk._search_api.by_image.by_image.ByImageSearch

ByImage search class which provides concrete methods for working with ByImage Search API and incapsulates search setting.

run(image_data, *, page=0, timeout=60)

Run a search query with given image_data bytes and search settings of this by_image search object.

To change initial search settings use .configure method:

>>> search = sdk.search_api.by_image(site="ya.ru")
>>> search = search.configure(site="yandex.ru")

Parameters

image_data (bytes) – The image data to use for the search.
page (int) – Requested page number.
timeout (float) – Timeout, or the maximum time to wait for the request to complete in seconds.

Returns

Parsed search results object.

Return type

ByImageSearchResult

run_from_url(url, *, page=0, timeout=60)

Run a search query with given image located at url and search settings of this by_image search object.

To change initial search settings use .configure method:

>>> search = sdk.search_api.by_image(site="ya.ru")
>>> search = search.configure(site="yandex.ru")

Parameters

url (str) – The image url to use for the search.
page (int) – Requested page number.
timeout (float) – Timeout, or the maximum time to wait for the request to complete in seconds.

Returns

Parsed search results object.

Return type

ByImageSearchResult

run_from_id(cbir_id, *, page=0, timeout=60)

Run a search query with given CBIR ID of the image and search settings of this by_image search object.

To change initial search settings use .configure method:

>>> search = sdk.search_api.by_image(site="ya.ru")
>>> search = search.configure(site="yandex.ru")

Parameters

id – CBIR ID of the image to use for the search.
page (int) – Requested page number.
timeout (float) – Timeout, or the maximum time to wait for the request to complete in seconds.
cbir_id (str)

Returns

Parsed search results object.

Return type

ByImageSearchResult

property config: ConfigTypeT

configure(*, family_mode=Undefined, site=Undefined)

Returns the new object with config fields overrode by passed values.

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

Parameters

family_mode (FamilyMode | UnknownEnumValue[FamilyMode] | str | int | Undefined | None) – Results filtering.
site (str | Undefined | None) – Restricts the search to the specific website.

Return type

Self

property uri: str

class yandex_cloud_ml_sdk._search_api.by_image.result.ByImageSearchResult

A class representing the result of a search by image request.

next_page(*, timeout=None)

Run a search by image request with previous search parameters except page number being increment by one.

Parameters	timeout (float \| None) – Timeout, or the maximum time to wait for the request to complete in seconds; if not given, initial timeout value from original search request are being used.
Return type	Self

count(value) → integer -- return number of occurrences of value

property docs: tuple[ByImageSearchDocument]... ,

Synonym for .images attribute

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

images: tuple[ByImageSearchDocument]... ,

cbir_id: str

page: int

Returned search page number.

Search API domain

class yandexcloudmlsdk.searchapi.domain.SearchAPIDomainclass yandex_cloud_ml_sdk._search_api.domain.SearchAPIDomain

Generative searchGenerative search

class yandexcloudmlsdk.searchapi.generative.function.GenerativeSearchFunctionclass yandex_cloud_ml_sdk._search_api.generative.function.GenerativeSearchFunction

class yandexcloudmlsdk.searchapi.generative.generative.GenerativeSearchclass yandex_cloud_ml_sdk._search_api.generative.generative.GenerativeSearch

Web searchWeb search

class yandexcloudmlsdk.searchapi.web.function.WebSearchFunctionclass yandex_cloud_ml_sdk._search_api.web.function.WebSearchFunction

class yandexcloudmlsdk.searchapi.web.web.WebSearchclass yandex_cloud_ml_sdk._search_api.web.web.WebSearch

class yandexcloudmlsdk.searchapi.web.result.WebSearchResultclass yandex_cloud_ml_sdk._search_api.web.result.WebSearchResult

Image searchImage search

class yandexcloudmlsdk.searchapi.image.function.ImageSearchFunctionclass yandex_cloud_ml_sdk._search_api.image.function.ImageSearchFunction

class yandexcloudmlsdk.searchapi.image.image.ImageSearchclass yandex_cloud_ml_sdk._search_api.image.image.ImageSearch

class yandexcloudmlsdk.searchapi.image.result.ImageSearchResultclass yandex_cloud_ml_sdk._search_api.image.result.ImageSearchResult

Search by imageSearch by image

class yandexcloudmlsdk.searchapi.byimage.function.ByImageSearchFunctionclass yandex_cloud_ml_sdk._search_api.by_image.function.ByImageSearchFunction

class yandexcloudmlsdk.searchapi.byimage.byimage.ByImageSearchclass yandex_cloud_ml_sdk._search_api.by_image.by_image.ByImageSearch

class yandexcloudmlsdk.searchapi.byimage.result.ByImageSearchResultclass yandex_cloud_ml_sdk._search_api.by_image.result.ByImageSearchResult

Была ли статья полезна?

class yandex_cloud_ml_sdk._search_api.domain.SearchAPIDomain

Generative search

class yandex_cloud_ml_sdk._search_api.generative.function.GenerativeSearchFunction

class yandex_cloud_ml_sdk._search_api.generative.generative.GenerativeSearch

Web search

class yandex_cloud_ml_sdk._search_api.web.function.WebSearchFunction

class yandex_cloud_ml_sdk._search_api.web.web.WebSearch

class yandex_cloud_ml_sdk._search_api.web.result.WebSearchResult

Image search

class yandex_cloud_ml_sdk._search_api.image.function.ImageSearchFunction

class yandex_cloud_ml_sdk._search_api.image.image.ImageSearch

class yandex_cloud_ml_sdk._search_api.image.result.ImageSearchResult

Search by image

class yandex_cloud_ml_sdk._search_api.by_image.function.ByImageSearchFunction

class yandex_cloud_ml_sdk._search_api.by_image.by_image.ByImageSearch

class yandex_cloud_ml_sdk._search_api.by_image.result.ByImageSearchResult