azure.search.documents.indexes.aio package¶
-
class
azure.search.documents.indexes.aio.
SearchIndexClient
(endpoint: str, credential: Union[azure.core.credentials.AzureKeyCredential, AsyncTokenCredential], **kwargs)[source]¶ A client to interact with Azure search service Indexes.
- Parameters
endpoint (str) – The URL endpoint of an Azure search service
credential (AzureKeyCredential or AsyncTokenCredential) – A credential to authorize search client requests
- Keyword Arguments
-
async
analyze_text
(index_name: str, analyze_request: AnalyzeTextOptions, **kwargs: Any) → AnalyzeResult[source]¶ Shows how an analyzer breaks text into tokens.
- Parameters
index_name (str) – The name of the index for which to test an analyzer.
analyze_request (AnalyzeTextOptions) – The text and analyzer or analysis components to test.
- Returns
AnalyzeResult
- Return type
AnalyzeRequest
- Raises
~azure.core.exceptions.HttpResponseError
Example:
from azure.core.credentials import AzureKeyCredential from azure.search.documents.indexes.aio import SearchIndexClient from azure.search.documents.indexes.models import AnalyzeTextOptions client = SearchIndexClient(service_endpoint, AzureKeyCredential(key)) analyze_request = AnalyzeTextOptions(text="One's <two/>", analyzer_name="standard.lucene") async with client: result = await client.analyze_text(index_name, analyze_request) print(result.as_dict())
-
async
close
() → None[source]¶ Close the
SearchIndexClient
session.
-
create_alias
(alias: SearchIndex, **kwargs: Any) → SearchAlias[source]¶ Creates a new search alias. :param alias: The alias object. :type alias: ~azure.search.documents.indexes.models.SearchAlias :return: The alias created :rtype: ~azure.search.documents.indexes.models.SearchAlias :raises: ~azure.core.exceptions.HttpResponseError
Example:
-
async
create_index
(index: SearchIndex, **kwargs: Any) → SearchIndex[source]¶ Creates a new search index.
- Parameters
index (
SearchIndex
) – The index object.- Returns
The index created
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
Example:
name = "hotels" fields = [ SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True), SimpleField(name="baseRate", type=SearchFieldDataType.Double), SearchableField(name="description", type=SearchFieldDataType.String, collection=True), ComplexField(name="address", fields=[ SimpleField(name="streetAddress", type=SearchFieldDataType.String), SimpleField(name="city", type=SearchFieldDataType.String), ], collection=True) ] cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60) scoring_profiles = [] index = SearchIndex( name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options) result = await client.create_index(index)
-
create_or_update_alias
(alias: str, **kwargs: azure.search.documents.indexes._generated.models._models_py3.SearchAlias) → azure.search.documents.indexes._generated.models._models_py3.SearchAlias[source]¶ Creates a new search alias or updates an alias if it already exists.
- Parameters
alias (SearchAlias) – The definition of the alias to create or update.
- Keyword Arguments
match_condition (MatchConditions) – The match condition to use upon the etag
- Returns
The index created or updated
- Return type
- Raises
ResourceNotFoundError
,ResourceModifiedError
,ResourceNotModifiedError
,ResourceNotFoundError
,ResourceExistsError
Example:
-
async
create_or_update_index
(index: azure.search.documents.indexes.models._index.SearchIndex, allow_index_downtime: bool = None, **kwargs: azure.core._match_conditions.MatchConditions) → azure.search.documents.indexes.models._index.SearchIndex[source]¶ Creates a new search index or updates an index if it already exists.
- Parameters
index (
SearchIndex
) – The index object.allow_index_downtime (bool) – Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes.
- Keyword Arguments
match_condition (MatchConditions) – The match condition to use upon the etag
- Returns
The index created or updated
- Return type
- Raises
ResourceNotFoundError
,ResourceModifiedError
,ResourceNotModifiedError
,ResourceNotFoundError
,ResourceExistsError
Example:
name = "hotels" fields = [ SimpleField(name="hotelId", type=SearchFieldDataType.String, key=True), SimpleField(name="baseRate", type=SearchFieldDataType.Double), SearchableField(name="description", type=SearchFieldDataType.String, collection=True), SearchableField(name="hotelName", type=SearchFieldDataType.String), ComplexField(name="address", fields=[ SimpleField(name="streetAddress", type=SearchFieldDataType.String), SimpleField(name="city", type=SearchFieldDataType.String), SimpleField(name="state", type=SearchFieldDataType.String), ], collection=True) ] cors_options = CorsOptions(allowed_origins=["*"], max_age_in_seconds=60) scoring_profile = ScoringProfile( name="MyProfile" ) scoring_profiles = [] scoring_profiles.append(scoring_profile) index = SearchIndex( name=name, fields=fields, scoring_profiles=scoring_profiles, cors_options=cors_options) result = await client.create_or_update_index(index=index)
-
async
create_or_update_synonym_map
(synonym_map: SynonymMap, **kwargs: Any) → SynonymMap[source]¶ Create a new Synonym Map in an Azure Search service, or update an existing one.
- Parameters
synonym_map (
SynonymMap
) – The Synonym Map object- Keyword Arguments
match_condition (MatchConditions) – The match condition to use upon the etag
- Returns
The created or updated Synonym Map
- Return type
-
async
create_synonym_map
(synonym_map: SynonymMap, **kwargs: Any) → SynonymMap[source]¶ Create a new Synonym Map in an Azure Search service
- Parameters
synonym_map (
SynonymMap
) – The Synonym Map object- Returns
The created Synonym Map
- Return type
Example:
synonyms = [ "USA, United States, United States of America", "Washington, Wash. => WA", ] synonym_map = SynonymMap(name="test-syn-map", synonyms=synonyms) result = await client.create_synonym_map(synonym_map) print("Create new Synonym Map 'test-syn-map succeeded")
-
delete_alias
(alias: Union[str, SearchAlias], **kwargs: Any) → None[source]¶ Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation :param alias: The alias name or object to delete. :type alias: str or ~azure.search.documents.indexes.models.SearchAlias :keyword match_condition: The match condition to use upon the etag :paramtype match_condition: ~azure.core.MatchConditions :raises: ~azure.core.exceptions.HttpResponseError
Example:
-
async
delete_index
(index: Union[str, SearchIndex], **kwargs: Any) → None[source]¶ Deletes a search index and all the documents it contains. The model must be provided instead of the name to use the access conditions
- Parameters
index (str or
SearchIndex
) – The index name or object to delete.- Keyword Arguments
match_condition (MatchConditions) – The match condition to use upon the etag
- Raises
~azure.core.exceptions.HttpResponseError
Example:
name = "hotels" await client.delete_index(name)
-
async
delete_synonym_map
(synonym_map: Union[str, SynonymMap], **kwargs: Any) → None[source]¶ Delete a named Synonym Map in an Azure Search service. To use access conditions, the SynonymMap model must be provided instead of the name. It is enough to provide the name of the synonym map to delete unconditionally.
- Parameters
name (str or SynonymMap) – The synonym map name or object to delete
- Keyword Arguments
match_condition (MatchConditions) – The match condition to use upon the etag
- Returns
None
- Return type
Example:
await client.delete_synonym_map("test-syn-map") print("Synonym Map 'test-syn-map' deleted")
-
get_alias
(name: str, **kwargs: Any) → SearchAlias[source]¶ - Parameters
name (str) – The name of the alias to retrieve.
- Returns
SearchAlias object
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
get_index
(name: str, **kwargs: Any) → SearchIndex[source]¶ - Parameters
name (str) – The name of the index to retrieve.
- Returns
SearchIndex object
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
Example:
name = "hotels" result = await client.get_index(name)
-
async
get_index_statistics
(index_name: str, **kwargs: Any) → dict[source]¶ Returns statistics for the given index, including a document count and storage usage.
-
get_search_client
(index_name: str, **kwargs: dict) → azure.search.documents.aio._search_client_async.SearchClient[source]¶ Return a client to perform operations on Search.
- Parameters
index_name (str) – The name of the Search Index
- Return type
-
async
get_service_statistics
(**kwargs: Any) → dict[source]¶ Get service level statistics for a search service.
-
async
get_synonym_map
(name: str, **kwargs: Any) → SynonymMap[source]¶ Retrieve a named Synonym Map in an Azure Search service
- Parameters
name (str) – The name of the Synonym Map to get
- Returns
The retrieved Synonym Map
- Return type
- Raises
Example:
result = await client.get_synonym_map("test-syn-map") print("Retrived Synonym Map 'test-syn-map' with synonyms") for syn in result.synonyms: print(" {}".format(syn))
-
async
get_synonym_map_names
(**kwargs: Any) → List[str][source]¶ List the Synonym Map names in an Azure Search service.
-
async
get_synonym_maps
(**kwargs: Any) → List[SynonymMap][source]¶ List the Synonym Maps in an Azure Search service.
- Keyword Arguments
select (list[str]) – Selects which top-level properties of the skillsets to retrieve. Specified as a list of JSON property names, or ‘*’ for all properties. The default is all properties.
- Returns
List of synonym maps
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
Example:
result = await client.get_synonym_maps() names = [x.name for x in result] print("Found {} Synonym Maps in the service: {}".format(len(result), ", ".join(names)))
-
list_alias_names
(**kwargs: Any) → AsyncItemPaged[str][source]¶ List the alias names in an Azure Search service.
- Returns
List of alias names
- Return type
AsyncItemPaged[str]
- Raises
~azure.core.exceptions.HttpResponseError
-
list_aliases
(**kwargs: Any) → AsyncItemPaged[SearchAlias][source]¶ List the aliases in an Azure Search service.
- Keyword Arguments
select (list[str]) – Selects which top-level properties of the skillsets to retrieve. Specified as a list of JSON property names, or ‘*’ for all properties. The default is all properties.
- Returns
List of Aliases
- Return type
AsyncItemPaged[SearchAlias]
- Raises
~azure.core.exceptions.HttpResponseError
-
list_index_names
(**kwargs: Any) → AsyncItemPaged[str][source]¶ List the index names in an Azure Search service.
- Returns
List of index names
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
list_indexes
(**kwargs: Any) → AsyncItemPaged[SearchIndex][source]¶ List the indexes in an Azure Search service.
- Keyword Arguments
select (list[str]) – Selects which top-level properties of the skillsets to retrieve. Specified as a list of JSON property names, or ‘*’ for all properties. The default is all properties.
- Returns
List of indexes
- Return type
~azure.core.async_paging.AsyncItemPaged[
SearchIndex
]- Raises
~azure.core.exceptions.HttpResponseError
-
class
azure.search.documents.indexes.aio.
SearchIndexerClient
(endpoint: str, credential: Union[azure.core.credentials.AzureKeyCredential, AsyncTokenCredential], **kwargs)[source]¶ A client to interact with Azure search service Indexers.
- Parameters
endpoint (str) – The URL endpoint of an Azure search service
credential (AzureKeyCredential or AsyncTokenCredential) – A credential to authorize search client requests
- Keyword Arguments
-
async
close
() → None[source]¶ Close the
SearchIndexerClient
session.
-
async
create_data_source_connection
(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) → SearchIndexerDataSourceConnection[source]¶ Creates a new data source connection. :param data_source_connection: The definition of the data source connection to create. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
Example:
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")
-
async
create_indexer
(indexer: SearchIndexer, **kwargs: Any) → SearchIndexer[source]¶ Creates a new SearchIndexer.
- Parameters
indexer (SearchIndexer) – The definition of the indexer to create.
- Returns
The created SearchIndexer
- Return type
Example:
-
async
create_or_update_data_source_connection
(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) → SearchIndexerDataSourceConnection[source]¶ Creates a new data source connection or updates a data source connection if it already exists. :param data_source_connection: The definition of the data source connection to create or update. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :keyword match_condition: The match condition to use upon the etag :paramtype match_condition: ~azure.core.MatchConditions :keyword skip_indexer_reset_requirement_for_cache: Ignores cache reset requirements. :paramtype skip_indexer_reset_requirement_for_cache: bool :return: The created SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
-
async
create_or_update_indexer
(indexer: SearchIndexer, **kwargs: Any) → SearchIndexer[source]¶ Creates a new indexer or updates a indexer if it already exists.
- Parameters
indexer (SearchIndexer) – The definition of the indexer to create or update.
- Keyword Arguments
- Returns
The created SearchIndexer
- Return type
-
async
create_or_update_skillset
(skillset: SearchIndexerSkillset, **kwargs: Any) → SearchIndexerSkillset[source]¶ Create a new SearchIndexerSkillset in an Azure Search service, or update an existing one.
- Parameters
skillset (
SearchIndexerSkillset
) – The SearchIndexerSkillset object to create or update- Keyword Arguments
match_condition (MatchConditions) – The match condition to use upon the etag
skip_indexer_reset_requirement_for_cache (bool) – Ignores cache reset requirements.
disable_cache_reprocessing_change_detection (bool) – Disables cache reprocessing change detection.
- Returns
The created or updated SearchIndexerSkillset
- Return type
-
async
create_skillset
(skillset: SearchIndexerSkillset, **kwargs: Any) → SearchIndexerSkillset[source]¶ Create a new SearchIndexerSkillset in an Azure Search service
- Parameters
skillset (SearchIndexerSkillset) – The SearchIndexerSkillset object to create
- Returns
The created SearchIndexerSkillset
- Return type
Example:
-
async
delete_data_source_connection
(data_source_connection: Union[str, SearchIndexerDataSourceConnection], **kwargs: Any) → None[source]¶ Deletes a data source connection. To use access conditions, the SearchIndexerDataSourceConnection model must be provided instead of the name. It is enough to provide the name of the data source connection to delete unconditionally
- Parameters
data_source_connection (str or SearchIndexerDataSourceConnection) – The data source connection to delete.
- Keyword Arguments
match_condition (MatchConditions) – The match condition to use upon the etag
- Returns
None
- Return type
Example:
-
async
delete_indexer
(indexer: Union[str, SearchIndexer], **kwargs: Any) → None[source]¶ Deletes an indexer. To use access conditions, the SearchIndexer model must be provided instead of the name. It is enough to provide the name of the indexer to delete unconditionally.
- Parameters
name (str or SearchIndexer) – The name or the indexer object to delete.
- Keyword Arguments
match_condition (MatchConditions) – The match condition to use upon the etag
- Returns
None
- Return type
Example:
-
async
delete_skillset
(skillset: Union[str, SearchIndexerSkillset], **kwargs: Any) → None[source]¶ Delete a named SearchIndexerSkillset in an Azure Search service. To use access conditions, the SearchIndexerSkillset model must be provided instead of the name. It is enough to provide the name of the skillset to delete unconditionally
- Parameters
skillset (str or SearchIndexerSkillset) – The SearchIndexerSkillset to delete
- Keyword Arguments
match_condition (MatchConditions) – The match condition to use upon the etag
Example:
-
async
get_data_source_connection
(name: str, **kwargs: Any) → SearchIndexerDataSourceConnection[source]¶ Retrieves a data source connection definition.
- Keyword Arguments
select (list[str]) – Selects which top-level properties of the skillsets to retrieve. Specified as a list of JSON property names, or ‘*’ for all properties. The default is all properties.
- Parameters
name (str) – The name of the data source connection to retrieve.
- Returns
The SearchIndexerDataSourceConnection that is fetched.
- Return type
~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
result = await client.get_data_source_connection("async-sample-data-source-connection") print("Retrived Data Source Connection 'async-sample-data-source-connection'") return result
-
async
get_data_source_connection_names
(**kwargs: Any) → Sequence[str][source]¶ Lists all data source connection names available for a search service.
- Returns
List of all the data source connection names.
- Return type
list[str]
-
async
get_data_source_connections
(**kwargs: Any) → Sequence[SearchIndexerDataSourceConnection][source]¶ Lists all data source connections available for a search service.
- Returns
List of all the data source connections.
- Return type
list[~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection]
Example:
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)))
-
async
get_indexer
(name: str, **kwargs: Any) → SearchIndexer[source]¶ Retrieves a indexer definition.
- Parameters
name (str) – The name of the indexer to retrieve.
- Returns
The SearchIndexer that is fetched.
- Return type
Example:
-
async
get_indexer_names
(**kwargs: Any) → Sequence[str][source]¶ Lists all indexer names available for a search service.
- Returns
List of all the SearchIndexer names.
- Return type
list[str]
-
async
get_indexer_status
(name: str, **kwargs: Any) → SearchIndexerStatus[source]¶ Get the status of the indexer.
- Parameters
name (str) – The name of the indexer to fetch the status.
- Returns
SearchIndexerStatus
- Return type
Example:
-
async
get_indexers
(**kwargs: Any) → Sequence[SearchIndexer][source]¶ Lists all indexers available for a search service.
- Keyword Arguments
select (list[str]) – Selects which top-level properties of the skillsets to retrieve. Specified as a list of JSON property names, or ‘*’ for all properties. The default is all properties.
- Returns
List of all the SearchIndexers.
- Return type
list[~azure.search.documents.indexes.models.SearchIndexer]
Example:
-
async
get_skillset
(name: str, **kwargs: Any) → SearchIndexerSkillset[source]¶ Retrieve a named SearchIndexerSkillset in an Azure Search service
- Parameters
name (str) – The name of the SearchIndexerSkillset to get
- Returns
The retrieved SearchIndexerSkillset
- Return type
- Raises
Example:
-
async
get_skillset_names
(**kwargs: Any) → List[str][source]¶ List the SearchIndexerSkillset names in an Azure Search service.
-
async
get_skillsets
(**kwargs: Any) → List[SearchIndexerSkillset][source]¶ List the SearchIndexerSkillsets in an Azure Search service.
- Keyword Arguments
select (list[str]) – Selects which top-level properties of the skillsets to retrieve. Specified as a list of JSON property names, or ‘*’ for all properties. The default is all properties.
- Returns
List of SearchIndexerSkillsets
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
Example:
-
async
reset_documents
(indexer: Union[str, SearchIndexer], keys_or_ids: DocumentKeysOrIds, **kwargs: Any) → None[source]¶ Resets specific documents in the datasource to be selectively re-ingested by the indexer.
- Parameters
indexer (str or SearchIndexer) – The indexer to reset documents for.
keys_or_ids (DocumentKeysOrIds) –
- Returns
None, or the result of cls(response)
- Keyword Arguments
overwrite (bool) – If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested. The default is false.
- Return type
- Raises
~azure.core.exceptions.HttpResponseError
-
async
reset_indexer
(name: str, **kwargs: Any) → None[source]¶ Resets the change tracking state associated with an indexer.
Example:
-
async
reset_skills
(skillset: Union[str, SearchIndexerSkillset], skill_names: List[str], **kwargs: Any) → None[source]¶ Reset an existing skillset in a search service.
- Parameters
skillset (str or SearchIndexerSkillset) – The SearchIndexerSkillset to reset
- Returns
None, or the result of cls(response)
- Return type
- Raises
~azure.core.exceptions.HttpResponseError