SearchIndexClient Class

Shows how an analyzer breaks text into tokens.

analyze_text(index_name: str, analyze_request: AnalyzeTextOptions, **kwargs: Any) -> AnalyzeResult

Parameters

Returns

Exceptions

Examples

Analyze text

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.indexes 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"
   )

   result = client.analyze_text(index_name, analyze_request)
   print(result.as_dict())

Close the session. :return: None :rtype: None

close() -> None

Creates a new search index.

create_index(index: SearchIndex, **kwargs: Any) -> SearchIndex

Parameters

Returns

Exceptions

Examples

Creating a new index.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   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: List[ScoringProfile] = []
   index = SearchIndex(
       name=name,
       fields=fields,
       scoring_profiles=scoring_profiles,
       cors_options=cors_options,
   )

   result = client.create_index(index)

Creates a new search index or updates an index if it already exists.

create_or_update_index(index: SearchIndex, allow_index_downtime: bool | None = None, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndex

Parameters

Keyword-Only Parameters

Returns

Exceptions

Examples

Update an index.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   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 = client.create_or_update_index(index=index)

Create a new Synonym Map in an Azure Search service, or update an existing one.

create_or_update_synonym_map(synonym_map: SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SynonymMap

Parameters

Keyword-Only Parameters

Returns

Create a new Synonym Map in an Azure Search service

create_synonym_map(synonym_map: SynonymMap, **kwargs: Any) -> SynonymMap

Parameters

Returns

Examples

Create a Synonym Map

   synonyms = [
       "USA, United States, United States of America",
       "Washington, Wash. => WA",
   ]
   synonym_map = SynonymMap(name="test-syn-map", synonyms=synonyms)
   result = client.create_synonym_map(synonym_map)
   print("Create new Synonym Map 'test-syn-map succeeded")

Deletes a search index and all the documents it contains. The model must be provided instead of the name to use the access conditions.

delete_index(index: str | SearchIndex, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parameters

Keyword-Only Parameters

Exceptions

Examples

Delete an index.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   client.delete_index(name)

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.

delete_synonym_map(synonym_map: str | SynonymMap, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parameters

Keyword-Only Parameters

Examples

Delete a Synonym Map

   client.delete_synonym_map("test-syn-map")
   print("Synonym Map 'test-syn-map' deleted")

get_index(name: str, **kwargs: Any) -> SearchIndex

Parameters

Returns

Exceptions

Examples

Get an index.

   client = SearchIndexClient(service_endpoint, AzureKeyCredential(key))
   name = "hotels"
   result = client.get_index(name)

Returns statistics for the given index, including a document count and storage usage.

get_index_statistics(index_name: str, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Returns

Exceptions

Return a client to perform operations on Search

get_search_client(index_name: str, **kwargs: Any) -> SearchClient

Parameters

Returns

Get service level statistics for a search service.

get_service_statistics(**kwargs: Any) -> MutableMapping[str, Any]

Returns

Retrieve a named Synonym Map in an Azure Search service

get_synonym_map(name: str, **kwargs: Any) -> SynonymMap

Parameters

Returns

Exceptions

Examples

Get a Synonym Map

   result = client.get_synonym_map("test-syn-map")
   print("Retrived Synonym Map 'test-syn-map' with synonyms")
   if result:
       for syn in result.synonyms:
           print("    {}".format(syn))

List the Synonym Map names in an Azure Search service.

get_synonym_map_names(**kwargs: Any) -> List[str]

Returns

Exceptions

List the Synonym Maps in an Azure Search service.

get_synonym_maps(*, select: List[str] | None = None, **kwargs) -> List[SynonymMap]

Keyword-Only Parameters

Returns

Exceptions

Examples

List Synonym Maps

   result = client.get_synonym_maps()
   names = [x.name for x in result]
   print(
       "Found {} Synonym Maps in the service: {}".format(len(result), ", ".join(names))
   )

List the index names in an Azure Search service.

list_index_names(**kwargs: Any) -> ItemPaged[str]

Returns

Exceptions

List the indexes in an Azure Search service.

list_indexes(*, select: List[str] | None = None, **kwargs: Any) -> ItemPaged[SearchIndex]

Keyword-Only Parameters

Returns

Exceptions

Runs a network request using the client's existing pipeline.

send_request(request: HttpRequest, *, stream: bool = False, **kwargs) -> HttpResponse

Parameters

Keyword-Only Parameters

Returns