Связаться с намиПодключиться

Search indexes domain

Статья создана
Обновлена 7 ноября 2025 г.

class yandex_cloud_ml_sdk._search_indexes.domain.SearchIndexes

A class for search indexes. It is a part of Assistants API and it provides the foundation for creating and managing search indexes.

create_deferred(files, *, index_type=Undefined, name=Undefined, description=Undefined, labels=Undefined, ttl_days=Undefined, expiration_policy=Undefined, timeout=60)

Create a deferred search index.

It returns an operation that can be used to track the creation process.

Parameters

  • files (str | BaseFile | Iterable[BaseFile] | Iterable[str]) – the files to be indexed.
  • index_type (BaseSearchIndexType | Undefined) – the type of the search index.
  • name (str | Undefined) – the name of the search index.
  • description (str | Undefined) – a description for the search index.
  • labels (dict[str, str] | Undefined) – a set of labels for the search index.
  • ttl_days (int | Undefined) – time-to-live in days for the search index.
  • expiration_policy (ExpirationPolicy | Literal[1, 2] | ~typing.Literal['STATIC', 'SINCE_LAST_ACTIVE'] | ~typing.Literal['static', 'since_last_active'] | ~yandex_cloud_ml_sdk._types.misc.Undefined) – expiration policy for the file. Assepts for passing static or since_last_active strings. Should be defined if ttl_days has been defined, otherwise both parameters should be undefined.
  • timeout (float) – the time to wait for the operation to complete. Defaults to 60 seconds.

Return type

Operation[SearchIndex]

get(search_index_id, *, timeout=60)

Retrieve a search index by its id.

This method fetches an already created search index using its unique identifier.

Parameters

  • search_index_id (str) – the unique identifier of the search index to retrieve.
  • timeout (float) – the time to wait for the operation to complete. Defaults to 60 seconds.

Return type

SearchIndex

list(*, page_size=Undefined, timeout=60)

List search indexes in the specified folder.

This method retrieves a list of search indexes. It continues to fetch search indexes until there are no more available.

Parameters

  • page_size (int | Undefined) – the maximum number of search indexes to return per page.
  • timeout (float) – the time to wait for the operation to complete. Defaults to 60 seconds.

Return type

Iterator[SearchIndex]

class yandex_cloud_ml_sdk._search_indexes.search_index.SearchIndex

update(*, name=Undefined, description=Undefined, labels=Undefined, ttl_days=Undefined, expiration_policy=Undefined, timeout=60)

Updates the search index with the provided parameters.

Parameters

  • name (str | Undefined) – the name of the search index.
  • description (str | Undefined) – a description for the search index.
  • labels (dict[str, str] | Undefined) – a set of labels for the search index.
  • ttl_days (int | Undefined) – time-to-live in days for the search index.
  • expiration_policy (ExpirationPolicy | Literal[1, 2] | ~typing.Literal['STATIC', 'SINCE_LAST_ACTIVE'] | ~typing.Literal['static', 'since_last_active'] | ~yandex_cloud_ml_sdk._types.misc.Undefined) – expiration policy for the search index.
  • timeout (float) – the time to wait for the update request. Defaults to 60 seconds.

Return type

Self

delete(*, timeout=60)

Deletes the search index.

Parameters

timeout (float) – the time to wait for the delete request. Defaults to 60 seconds.

Return type

None

get_file(file_id, *, timeout=60)

Parameters

Return type

SearchIndexFile

list_files(*, page_size=Undefined, timeout=60)

Lists all files associated with the search index.

Parameters

  • page_size (int | Undefined) – the number of files to retrieve per page.
  • timeout (float) – the time to wait for the list request. Defaults to 60 seconds.

Return type

Iterator[SearchIndexFile]

add_files_deferred(files, *, timeout=60)

Adds files to the search index in a deferred manner.

Parameters

Return type

Operation[tuple[SearchIndexFile, …]]

folder_id: str

the ID of the folder

name: str | None

the new name for the search index

description: str | None

the new description for the search index

created_by: str

the user who created the search index

created_at: datetime

the timestamp when the search index was created

updated_by: str

the user who last updated the search index

updated_at: datetime

the timestamp when the search index was last updated

expires_at: datetime

the expiration date and time of the search index

labels: dict[str, str] | None

a dictionary of labels to associate with the search index

index_type: BaseSearchIndexType

the type of the search index

expiration_config: ExpirationConfig

id: str

Предыдущая
Runs domain
Следующая
Search API domain