SearchIndexClient Klass

Visar hur ett analysverktyg delar upp text i token.

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

Parametrar

Returer

AnalyzeResult

Returtyp

Undantag

Exempel

Analysera 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())

SearchIndexClient Stäng sessionen.

close() -> None

Undantag

Skapar ett nytt sökindex.

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

Parametrar

Returer

Indexet som skapats

Returtyp

Undantag

Exempel

Skapa ett nytt 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)

Skapar ett nytt sökindex eller uppdaterar ett index om det redan finns.

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

Parametrar

Returer

Indexet som skapats eller uppdaterats

Returtyp

Undantag

Exempel

Uppdatera ett 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)

Skapa en ny synonymkarta i en Azure-tjänsten Search eller uppdatera en befintlig mappning.

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

Parametrar

Returer

Den skapade eller uppdaterade synonymmappningen

Returtyp

Undantag

Skapa en ny synonymkarta i en Azure-tjänsten Search

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

Parametrar

Returer

Den skapade synonymkartan

Returtyp

Undantag

Exempel

Skapa en synonymkarta

   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")

Tar bort ett sökindex och alla dokument som det innehåller. Modellen måste anges i stället för namnet för att åtkomstvillkoren ska kunna användas.

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

Parametrar

Undantag

Exempel

Ta bort ett index.

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

Ta bort en namngiven synonymkarta i en Azure-tjänsten Search. Om du vill använda åtkomstvillkor måste SynonymMap-modellen anges i stället för namnet. Det räcker att ange namnet på synonymkartan för att ta bort villkorslöst.

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

Parametrar

Returer

Ingen

Returtyp

Undantag

Exempel

Ta bort en synonymmappning

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

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

Parametrar

Returer

SearchIndex-objekt

Returtyp

Undantag

Exempel

Hämta ett index.

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

Returnerar statistik för det angivna indexet, inklusive ett antal dokument och lagringsanvändning.

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

Parametrar

Returer

Statistik för det angivna indexet, inklusive ett antal dokument och lagringsanvändning.

Returtyp

Undantag

Returnera en klient för att utföra åtgärder vid sökning

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

Parametrar

Returer

SearchClient-objekt

Returtyp

Undantag

Hämta statistik på tjänstnivå för en söktjänst.

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

Returer

Resultat av tjänststatistik.

Returtyp

Undantag

Hämta en namngiven synonymkarta i en Azure-tjänsten Search

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

Parametrar

Returer

Den hämtade synonymkartan

Returtyp

Undantag

Exempel

Hämta en synonymkarta

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

Visa en lista över synonymmappningsnamn i en Azure-tjänsten Search.

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

Returer

Lista över synonymmappningar

Returtyp

Undantag

Visa en lista över synonymkartor i en Azure-tjänsten Search.

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

Parametrar

Returer

Lista över synonymmappningar

Returtyp

Undantag

Exempel

Lista synonymkartor

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

Lista indexnamnen i en Azure-tjänsten Search.

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

Returer

Lista över indexnamn

Returtyp

Undantag

Lista indexen i en Azure-tjänsten Search.

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

Parametrar

Returer

Lista över index

Returtyp

Undantag