SearchIndexerClient Класс

Ссылка

Клиент для взаимодействия с индексаторами службы поиска Azure.

Наследование: azure.search.documents._headers_mixin.HeadersMixin

SearchIndexerClient

Конструктор

SearchIndexerClient(endpoint: str, credential: AzureKeyCredential | AsyncTokenCredential, **kwargs)

Параметры

endpoint: str

Обязательно

Конечная точка URL-адреса службы поиска Azure

credential: AzureKeyCredential или AsyncTokenCredential

Обязательно

Учетные данные для авторизации поисковых запросов клиентов

api_version: str

Версия API поиска, используемая для запросов.

audience: str

задает аудиторию, используемую для проверки подлинности с помощью Azure Active Directory (AAD). Аудитория не учитывается при использовании общего ключа. Если аудитория не указана, предполагается аудитория общедоступного облака.

Методы

close	SearchIndexerClient Закройте сеанс.
create_data_source_connection	Создает новое подключение к источнику данных. :p aram data_source_connection: определение создаваемого подключения к источнику данных. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :return: Созданная функция SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
create_indexer	Создает новый searchIndexer.
create_or_update_data_source_connection	Создает новое подключение к источнику данных или обновляет подключение к источнику данных, если оно уже существует. :p aram data_source_connection: определение создаваемого или обновляемого подключения к источнику данных. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :ключевое слово match_condition: условие соответствия, используемое для etag :p aramtype match_condition: ~azure.core.MatchConditions :return: созданный SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
create_or_update_indexer	Создает новый индексатор или обновляет индексатор, если он уже существует.
create_or_update_skillset	Создайте новый searchIndexerSkillset в служба Azure или обновите существующий.
create_skillset	Создание объекта SearchIndexerSkillset в служба Azure
delete_data_source_connection	Удаляет подключение к источнику данных. Чтобы использовать условия доступа, вместо имени необходимо указать модель SearchIndexerDataSourceConnection. Достаточно указать имя подключения к источнику данных, чтобы удалить безоговорочно.
delete_indexer	Удаляет индексатор. Чтобы использовать условия доступа, вместо имени необходимо указать модель SearchIndexer. Достаточно указать имя индексатора для безусловного удаления.
delete_skillset	Удалите объект с именем SearchIndexerSkillset в служба Azure. Чтобы использовать условия доступа, вместо имени необходимо указать модель SearchIndexerSkillset. Достаточно указать имя набора навыков для безусловного удаления.
get_data_source_connection	Извлекает определение подключения к источнику данных.
get_data_source_connection_names	Список всех имен подключений к источникам данных, доступных для службы поиска.
get_data_source_connections	Выводит список всех подключений к источникам данных, доступных для службы поиска.
get_indexer	Извлекает определение индексатора.
get_indexer_names	Список всех имен индексатора, доступных для службы поиска.
get_indexer_status	Получение состояния индексатора.
get_indexers	Список всех индексаторов, доступных для службы поиска.
get_skillset	Получение с именем SearchIndexerSkillset в служба Azure
get_skillset_names	Перечислите имена SearchIndexerSkillset в служба Azure.
get_skillsets	Перечисление наборов SearchIndexerSkillsets в служба Azure.
reset_indexer	Сбрасывает состояние отслеживания изменений, связанное с индексатором.
run_indexer	Запустите индексатор.

close

SearchIndexerClient Закройте сеанс.

async close() -> None

Возвращаемое значение

Нет

Возвращаемый тип

None

create_data_source_connection

Создает новое подключение к источнику данных. :p aram data_source_connection: определение создаваемого подключения к источнику данных. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :return: Созданная функция SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

async create_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) -> SearchIndexerDataSourceConnection

Примеры

Создание SearchIndexerDataSourceConnection


   container = SearchIndexerDataContainer(name="searchcontainer")
   data_source = SearchIndexerDataSourceConnection(
       name="async-sample-data-source-connection",
       type="azureblob",
       connection_string=connection_string,
       container=container,
   )
   result = await client.create_data_source_connection(data_source)
   print("Create new Data Source Connection - async-sample-data-source-connection")

create_indexer

Создает новый searchIndexer.

async create_indexer(indexer: SearchIndexer, **kwargs: Any) -> SearchIndexer

Параметры

indexer: SearchIndexer

Обязательно

Определение создаваемого индексатора.

Возвращаемое значение

Созданный searchIndexer

Возвращаемый тип

SearchIndexer

create_or_update_data_source_connection

Создает новое подключение к источнику данных или обновляет подключение к источнику данных, если оно уже существует. :p aram data_source_connection: определение создаваемого или обновляемого подключения к источнику данных. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :ключевое слово match_condition: условие соответствия, используемое для etag :p aramtype match_condition: ~azure.core.MatchConditions :return: созданный SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

async create_or_update_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerDataSourceConnection

create_or_update_indexer

Создает новый индексатор или обновляет индексатор, если он уже существует.

async create_or_update_indexer(indexer: SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexer

Параметры

indexer: SearchIndexer

Обязательно

Определение индексатора для создания или обновления.

Возвращаемое значение

Созданный searchIndexer

Возвращаемый тип

SearchIndexer

create_or_update_skillset

Создайте новый searchIndexerSkillset в служба Azure или обновите существующий.

async create_or_update_skillset(skillset: SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerSkillset

Параметры

skillset: SearchIndexerSkillset

Обязательно

Объект SearchIndexerSkillset для создания или обновления

match_condition: MatchConditions

Условие соответствия, используемое для etag

Возвращаемое значение

Созданный или обновленный searchIndexerSkillset

Возвращаемый тип

SearchIndexerSkillset

create_skillset

Создание объекта SearchIndexerSkillset в служба Azure

async create_skillset(skillset: SearchIndexerSkillset, **kwargs: Any) -> SearchIndexerSkillset

Параметры

skillset: SearchIndexerSkillset

Обязательно

Создаваемый объект SearchIndexerSkillset

Возвращаемое значение

Созданный searchIndexerSkillset

Возвращаемый тип

SearchIndexerSkillset

delete_data_source_connection

Удаляет подключение к источнику данных. Чтобы использовать условия доступа, вместо имени необходимо указать модель SearchIndexerDataSourceConnection. Достаточно указать имя подключения к источнику данных, чтобы удалить безоговорочно.

async delete_data_source_connection(data_source_connection: str | SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Параметры

data_source_connection: str или SearchIndexerDataSourceConnection

Обязательно

Удаляемое подключение к источнику данных.

match_condition: MatchConditions

Условие соответствия, используемое для etag

Возвращаемое значение

Нет

Возвращаемый тип

None

delete_indexer

Удаляет индексатор. Чтобы использовать условия доступа, вместо имени необходимо указать модель SearchIndexer. Достаточно указать имя индексатора для безусловного удаления.

async delete_indexer(indexer: str | SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Параметры

name: str или SearchIndexer

Обязательно

Имя или удаляемый объект индексатора.

match_condition: MatchConditions

Условие соответствия, используемое для etag

Возвращаемое значение

Нет

Возвращаемый тип

None

delete_skillset

Удалите объект с именем SearchIndexerSkillset в служба Azure. Чтобы использовать условия доступа, вместо имени необходимо указать модель SearchIndexerSkillset. Достаточно указать имя набора навыков для безусловного удаления.

async delete_skillset(skillset: str | SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Параметры

skillset: str или SearchIndexerSkillset

Обязательно

Удаляемая функция SearchIndexerSkillset

match_condition: MatchConditions

Условие соответствия, используемое для etag

get_data_source_connection

Извлекает определение подключения к источнику данных.

async get_data_source_connection(name: str, *, select: List[str] | None = None, **kwargs: Any) -> SearchIndexerDataSourceConnection

Параметры

select: list[str]

Выбирает свойства верхнего уровня наборов навыков, которые требуется извлечь. Указывается в виде списка имен свойств JSON или "*" для всех свойств. По умолчанию используется значение all properties.

name: str

Обязательно

Имя извлекаемого подключения к источнику данных.

Возвращаемое значение

Извлекаемое соединение SearchIndexerDataSourceConnection.

Возвращаемый тип

SearchIndexerDataSourceConnection<xref:Retrieve> <xref:a> SearchIndexerDataSourceConnection <xref:result> = <xref:await> <xref:client.get_data_source_connection>("<xref:async>-<xref:sample>-<xref:data>-<xref:source>-<xref:connection>") print("<xref:Retrived> <xref:Data> <xref:Source> <xref:Connection> '<xref:async>-<xref:sample>-<xref:data>-<xref:source>-<xref:connection>'") <xref:return> <xref:result>

get_data_source_connection_names

Список всех имен подключений к источникам данных, доступных для службы поиска.

async get_data_source_connection_names(**kwargs) -> Sequence[str]

Возвращаемое значение

Список всех имен подключений к источнику данных.

Возвращаемый тип

list[str]

get_data_source_connections

Выводит список всех подключений к источникам данных, доступных для службы поиска.

async get_data_source_connections(**kwargs: Any) -> Sequence[SearchIndexerDataSourceConnection]

Возвращаемое значение

Список всех подключений к источникам данных.

Возвращаемый тип

list[SearchIndexerDataSourceConnection]

Примеры

Вывод списка всех SearchIndexerDataSourceConnections


   result = await client.get_data_source_connections()
   names = [x.name for x in result]
   print("Found {} Data Source Connections in the service: {}".format(len(result), ", ".join(names)))

get_indexer

Извлекает определение индексатора.

async get_indexer(name: str, **kwargs: Any) -> SearchIndexer

Параметры

name: str

Обязательно

Имя возвращаемого индексатора.

Возвращаемое значение

Извлекаемый объект SearchIndexer.

Возвращаемый тип

SearchIndexer

get_indexer_names

Список всех имен индексатора, доступных для службы поиска.

async get_indexer_names(**kwargs) -> Sequence[str]

Возвращаемое значение

Список всех имен SearchIndexer.

Возвращаемый тип

list[str]

get_indexer_status

Получение состояния индексатора.

async get_indexer_status(name: str, **kwargs: Any) -> SearchIndexerStatus

Параметры

name: str

Обязательно

Имя индексатора для получения состояния.

Возвращаемое значение

SearchIndexerStatus

Возвращаемый тип

SearchIndexerStatus

get_indexers

Список всех индексаторов, доступных для службы поиска.

async get_indexers(*, select: List[str] | None = None, **kwargs) -> Sequence[SearchIndexer]

Параметры

select: list[str]

Возвращаемое значение

Список всех объектов SearchIndexers.

Возвращаемый тип

list[~SearchIndexer]

get_skillset

Получение с именем SearchIndexerSkillset в служба Azure

async get_skillset(name: str, **kwargs) -> SearchIndexerSkillset

Параметры

name: str

Обязательно

Имя получаемого набора searchIndexerSkillset

Возвращаемое значение

Полученный searchIndexerSkillset

Возвращаемый тип

SearchIndexerSkillset

Исключения

ResourceNotFoundError

get_skillset_names

Перечислите имена SearchIndexerSkillset в служба Azure.

async get_skillset_names(**kwargs) -> List[str]

Возвращаемое значение

Список имен SearchIndexerSkillset

Возвращаемый тип

list[str]

Исключения

HttpResponseError

get_skillsets

Перечисление наборов SearchIndexerSkillsets в служба Azure.

async get_skillsets(*, select: List[str] | None = None, **kwargs) -> List[SearchIndexerSkillset]

Параметры

select: list[str]

Возвращаемое значение

Список наборов SearchIndexerSkillsets

Возвращаемый тип

list[SearchIndexerSkillset]

Исключения

HttpResponseError

reset_indexer

Сбрасывает состояние отслеживания изменений, связанное с индексатором.

async reset_indexer(name: str, **kwargs: Any) -> None

Параметры

name: str

Обязательно

Имя сбрасываемого индексатора.

Возвращаемое значение

Нет

Возвращаемый тип

None

run_indexer

Запустите индексатор.

async run_indexer(name: str, **kwargs: Any) -> None

Параметры

name: str

Обязательно

Имя выполняющегося индексатора.

Возвращаемое значение

Нет

Возвращаемый тип

None

Поделиться через

SearchIndexerClient Класс

Конструктор

Параметры

Методы

close

Возвращаемое значение

Возвращаемый тип

create_data_source_connection

Примеры

create_indexer

Параметры

Возвращаемое значение

Возвращаемый тип

create_or_update_data_source_connection

create_or_update_indexer

Параметры

Возвращаемое значение

Возвращаемый тип

create_or_update_skillset

Параметры

Возвращаемое значение

Возвращаемый тип

create_skillset

Параметры

Возвращаемое значение

Возвращаемый тип

delete_data_source_connection

Параметры

Возвращаемое значение

Возвращаемый тип

delete_indexer

Параметры

Возвращаемое значение

Возвращаемый тип

delete_skillset

Параметры

get_data_source_connection

Параметры

Возвращаемое значение

Возвращаемый тип

get_data_source_connection_names

Возвращаемое значение

Возвращаемый тип

get_data_source_connections

Возвращаемое значение

Возвращаемый тип

Примеры

get_indexer

Параметры

Возвращаемое значение

Возвращаемый тип

get_indexer_names

Возвращаемое значение

Возвращаемый тип

get_indexer_status

Параметры

Возвращаемое значение

Возвращаемый тип

get_indexers

Параметры

Возвращаемое значение

Возвращаемый тип

get_skillset

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

get_skillset_names

Возвращаемое значение

Возвращаемый тип

Исключения

get_skillsets

Параметры

Возвращаемое значение

Возвращаемый тип

Исключения

reset_indexer

Параметры

Возвращаемое значение