SearchIndexerClient Класс
Клиент для взаимодействия с индексаторами службы поиска Azure.
- Наследование
-
azure.search.documents._headers_mixin.HeadersMixinSearchIndexerClient
Конструктор
SearchIndexerClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)
Параметры
- credential
- AzureKeyCredential или TokenCredential
Учетные данные для авторизации запросов клиентов поиска
- api_version
- str
Версия API поиска, используемая для запросов.
- audience
- str
задает аудиторию, используемую для проверки подлинности в Azure Active Directory (AAD). Аудитория не учитывается при использовании общего ключа. Если аудитория не указана, предполагается аудитория общедоступного облака.
Методы
close |
SearchIndexerClient Закройте сеанс. |
create_data_source_connection |
Создает новое подключение к источнику данных. |
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 Закройте сеанс.
close() -> None
create_data_source_connection
Создает новое подключение к источнику данных.
create_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) -> SearchIndexerDataSourceConnection
Параметры
- data_source_connection
- SearchIndexerDataSourceConnection
Определение создаваемого подключения к источнику данных.
Возвращаемое значение
Созданная функция SearchIndexerDataSourceConnection
Возвращаемый тип
Примеры
Создание источника данных
container = SearchIndexerDataContainer(name="searchcontainer")
data_source_connection = SearchIndexerDataSourceConnection(
name="sample-data-source-connection", type="azureblob", connection_string=connection_string, container=container
)
result = client.create_data_source_connection(data_source_connection)
print(result)
print("Create new Data Source Connection - sample-data-source-connection")
create_indexer
Создает новый searchIndexer.
create_indexer(indexer: SearchIndexer, **kwargs: Any) -> 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
create_or_update_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerDataSourceConnection
create_or_update_indexer
Создает новый индексатор или обновляет индексатор, если он уже существует.
create_or_update_indexer(indexer: SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexer
Параметры
- match_condition
- MatchConditions
Условие соответствия, используемое для etag
Возвращаемое значение
Созданный searchIndexer
Возвращаемый тип
create_or_update_skillset
Создайте новый searchIndexerSkillset в служба Azure или обновите существующий.
create_or_update_skillset(skillset: SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerSkillset
Параметры
- match_condition
- MatchConditions
Условие соответствия, используемое для etag
Возвращаемое значение
Созданный или обновленный SearchIndexerSkillset
Возвращаемый тип
create_skillset
Создание searchIndexerSkillset в azure служба
create_skillset(skillset: SearchIndexerSkillset, **kwargs: Any) -> SearchIndexerSkillset
Параметры
Возвращаемое значение
Созданный searchIndexerSkillset
Возвращаемый тип
delete_data_source_connection
Удаляет подключение к источнику данных. Чтобы использовать условия доступа, вместо имени необходимо указать модель SearchIndexerDataSourceConnection. Достаточно указать имя подключения к источнику данных для безусловного удаления.
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
Возвращаемое значение
Нет
Возвращаемый тип
Примеры
Удаление SearchIndexerDataSourceConnection
client.delete_data_source_connection("sample-data-source-connection")
print("Data Source Connection 'sample-data-source-connection' successfully deleted")
delete_indexer
Удаляет индексатор. Чтобы использовать условия доступа, вместо имени необходимо указать модель SearchIndexer. Достаточно указать имя индексатора для безусловного удаления.
delete_indexer(indexer: str | SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None
Параметры
- match_condition
- MatchConditions
Условие соответствия, используемое для etag
Возвращаемое значение
Нет
Возвращаемый тип
delete_skillset
Удалите объект с именем SearchIndexerSkillset в служба Azure. Чтобы использовать условия доступа, вместо имени необходимо указать модель SearchIndexerSkillset. Достаточно указать имя набора навыков для безусловного удаления.
delete_skillset(skillset: str | SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None
Параметры
- match_condition
- MatchConditions
Условие соответствия, используемое для etag
get_data_source_connection
Извлекает определение подключения к источнику данных.
get_data_source_connection(name: str, **kwargs: Any) -> SearchIndexerDataSourceConnection
Параметры
Возвращаемое значение
Извлекаемое свойство SearchIndexerDataSourceConnection.
Возвращаемый тип
Примеры
Получение searchIndexerDataSourceConnection
result = client.get_data_source_connection("sample-data-source-connection")
print("Retrived Data Source Connection 'sample-data-source-connection'")
get_data_source_connection_names
Список всех имен подключений к источникам данных, доступных для службы поиска.
get_data_source_connection_names(**kwargs: Any) -> Sequence[str]
Возвращаемое значение
Список всех имен подключений к источнику данных.
Возвращаемый тип
get_data_source_connections
Список всех подключений к источникам данных, доступных для службы поиска.
get_data_source_connections(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexerDataSourceConnection]
Параметры
Выбирает свойства верхнего уровня наборов навыков для извлечения. Указывается в виде списка имен свойств JSON или "*" для всех свойств. Значением по умолчанию являются все свойства.
Возвращаемое значение
Список всех подключений к источнику данных.
Возвращаемый тип
Примеры
Перечисление всех элементов SearchIndexerDataSourceConnections
result = client.get_data_source_connections()
names = [ds.name for ds in result]
print("Found {} Data Source Connections in the service: {}".format(len(result), ", ".join(names)))
get_indexer
Извлекает определение индексатора.
get_indexer(name: str, **kwargs: Any) -> SearchIndexer
Параметры
Возвращаемое значение
Извлекаемый объект SearchIndexer.
Возвращаемый тип
get_indexer_names
Список всех имен индексатора, доступных для службы поиска.
get_indexer_names(**kwargs: Any) -> Sequence[str]
Возвращаемое значение
Список всех объектов SearchIndexers.
Возвращаемый тип
get_indexer_status
Получение состояния индексатора.
get_indexer_status(name: str, **kwargs: Any) -> SearchIndexerStatus
Параметры
Возвращаемое значение
SearchIndexerStatus
Возвращаемый тип
get_indexers
Список всех индексаторов, доступных для службы поиска.
get_indexers(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexer]
Параметры
Выбирает свойства верхнего уровня наборов навыков для извлечения. Указывается в виде списка имен свойств JSON или "*" для всех свойств. Значением по умолчанию являются все свойства.
Возвращаемое значение
Список всех объектов SearchIndexers.
Возвращаемый тип
get_skillset
Получение объекта с именем SearchIndexerSkillset в служба Azure
get_skillset(name: str, **kwargs: Any) -> SearchIndexerSkillset
Параметры
Возвращаемое значение
Полученный searchIndexerSkillset
Возвращаемый тип
Исключения
get_skillset_names
Перечисление имен SearchIndexerSkillset в служба Azure.
get_skillset_names(**kwargs: Any) -> List[str]
Возвращаемое значение
Список имен SearchIndexerSkillset
Возвращаемый тип
Исключения
get_skillsets
Перечислите наборы SearchIndexerSkillsets в служба Azure.
get_skillsets(*, select: List[str] | None = None, **kwargs: Any) -> List[SearchIndexerSkillset]
Параметры
Выбирает свойства верхнего уровня наборов навыков для извлечения. Указывается в виде списка имен свойств JSON или "*" для всех свойств. Значением по умолчанию являются все свойства.
Возвращаемое значение
Список searchIndexerSkillsets
Возвращаемый тип
Исключения
reset_indexer
Сбрасывает состояние отслеживания изменений, связанное с индексатором.
reset_indexer(name: str, **kwargs: Any) -> None
Параметры
Возвращаемое значение
Нет
Возвращаемый тип
run_indexer
Azure SDK for Python