SearchIndexClient Klasse

Ein Client für die Interaktion mit dem Azure Search-Dienstindex.

Vererbung

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Konstruktor

SearchIndexClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

Parameter

endpoint

str

Erforderlich

Der URL-Endpunkt eines Azure-Suchdiensts

credential

AzureKeyCredential oder TokenCredential

Erforderlich

Anmeldeinformationen zum Autorisieren von Suchclientanforderungen

api_version

str

Die Such-API-Version, die für Anforderungen verwendet werden soll.

audience

str

legt die Zielgruppe fest, die für die Authentifizierung mit Azure Active Directory (AAD) verwendet werden soll. Die Zielgruppe wird bei verwendung eines freigegebenen Schlüssels nicht berücksichtigt. Wenn keine Zielgruppe bereitgestellt wird, wird die Öffentliche Cloud-Zielgruppe angenommen.

Methoden

analyze_text	Zeigt, wie ein Analysetool Text in Token unterbricht.
close	Schließen Sie die SearchIndexClient Sitzung.
create_index	Erstellt einen neuen Suchindex.
create_or_update_index	Erstellt einen neuen Suchindex oder aktualisiert einen Index, falls er bereits vorhanden ist.
create_or_update_synonym_map	Erstellen Sie eine neue Synonymzuordnung in einer Azure-Suchdienst, oder aktualisieren Sie eine vorhandene.
create_synonym_map	Erstellen einer neuen Synonymzuordnung in einer Azure-Suchdienst
delete_index	Löscht einen Suchindex und alle darin enthaltenen Dokumente. Das Modell muss anstelle des Namens angegeben werden, um die Zugriffsbedingungen zu verwenden.
delete_synonym_map	Löschen Sie eine benannte Synonymzuordnung in einer Azure-Suchdienst. Um Zugriffsbedingungen zu verwenden, muss anstelle des Namens das SynonymMap-Modell angegeben werden. Es reicht aus, den Namen der Synonymzuordnung anzugeben, um bedingungslos zu löschen.
get_index
get_index_statistics	Gibt Statistiken für den angegebenen Index zurück, einschließlich dokumentanzahl und Speichernutzung.
get_search_client	Zurückgeben eines Clients zum Ausführen von Vorgängen in der Suche
get_service_statistics	Abrufen von Dienstebenenstatistiken für einen Suchdienst.
get_synonym_map	Abrufen einer benannten Synonymzuordnung in einer Azure-Suchdienst
get_synonym_map_names	Listet die Synonymzuordnungsnamen in einer Azure-Suchdienst auf.
get_synonym_maps	Listen Sie die Synonymzuordnungen in einer Azure-Suchdienst auf.
list_index_names	Listen Sie die Indexnamen in einer Azure-Suchdienst auf.
list_indexes	Listen Sie die Indizes in einer Azure-Suchdienst auf.

analyze_text

Zeigt, wie ein Analysetool Text in Token unterbricht.

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

Parameter

index_name

str

Erforderlich

Der Name des Indexes, für den ein Analysetool getestet werden soll.

analyze_request

AnalyzeTextOptions

Erforderlich

Die zu testenden Text- und Analysekomponenten.

Gibt zurück

AnalyzeResult

Rückgabetyp

AnalyzeResult

Ausnahmen

HttpResponseError

Beispiele

Analysieren von 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

Schließen Sie die SearchIndexClient Sitzung.

close() -> None

Ausnahmen

HttpResponseError

create_index

Erstellt einen neuen Suchindex.

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

Parameter

index

SearchIndex

Erforderlich

Das index-Objekt.

Gibt zurück

Der erstellte Index

Rückgabetyp

SearchIndex

Ausnahmen

HttpResponseError

Beispiele

Erstellen eines neuen Indexes.

   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)

create_or_update_index

Erstellt einen neuen Suchindex oder aktualisiert einen Index, falls er bereits vorhanden ist.

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

Parameter

index

SearchIndex

Erforderlich

Das index-Objekt.

allow_index_downtime

bool

Erforderlich

Ermöglicht das Hinzufügen neuer Analysetools, Tokenisierer, Tokenfilter oder Zeichenfilter zu einem Index, indem der Index für mindestens einige Sekunden offline geschaltet wird. Dies führt vorübergehend zu Fehlern bei Indizierungs- und Abfrageanforderungen. Leistung und Schreibverfügbarkeit des Indexes können nach der Indexaktualisierung mehrere Minuten lang eingeschränkt sein, bei sehr großen Indizes auch länger.

match_condition

MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll

Gibt zurück

Der erstellte oder aktualisierte Index

Rückgabetyp

SearchIndex

Ausnahmen

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Beispiele

Aktualisieren sie einen 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_or_update_synonym_map

Erstellen Sie eine neue Synonymzuordnung in einer Azure-Suchdienst, oder aktualisieren Sie eine vorhandene.

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

Parameter

synonym_map

SynonymMap

Erforderlich

Das Synonym Map-Objekt

match_condition

MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll

Gibt zurück

Die erstellte oder aktualisierte Synonymzuordnung

Rückgabetyp

SynonymMap

Ausnahmen

HttpResponseError

create_synonym_map

Erstellen einer neuen Synonymzuordnung in einer Azure-Suchdienst

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

Parameter

synonym_map

SynonymMap

Erforderlich

Das Synonym Map-Objekt

Gibt zurück

Die erstellte Synonymzuordnung

Rückgabetyp

SynonymMap

Ausnahmen

HttpResponseError

Beispiele

Erstellen einer Synonymzuordnung

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

delete_index

Löscht einen Suchindex und alle darin enthaltenen Dokumente. Das Modell muss anstelle des Namens angegeben werden, um die Zugriffsbedingungen zu verwenden.

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

Parameter

index

str oder SearchIndex

Erforderlich

Der zu löschende Indexname oder das zu löschende Objekt.

match_condition

MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll

Ausnahmen

HttpResponseError

Beispiele

Löscht einen Index.

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

delete_synonym_map

Löschen Sie eine benannte Synonymzuordnung in einer Azure-Suchdienst. Um Zugriffsbedingungen zu verwenden, muss anstelle des Namens das SynonymMap-Modell angegeben werden. Es reicht aus, den Namen der Synonymzuordnung anzugeben, um bedingungslos zu löschen.

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

Parameter

name

str oder SynonymMap

Erforderlich

Der Zu löschende Name der Synonymzuordnung oder das zu löschende Objekt

match_condition

MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll

Gibt zurück

Keine

Rückgabetyp

None

Ausnahmen

HttpResponseError

Beispiele

Löschen einer Synonymzuordnung

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

get_index

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

Parameter

name

str

Erforderlich

Der Name des abzurufenden Indexes.

Gibt zurück

SearchIndex-Objekt

Rückgabetyp

SearchIndex

Ausnahmen

HttpResponseError

Beispiele

Rufen Sie einen Index ab.

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

get_index_statistics

Gibt Statistiken für den angegebenen Index zurück, einschließlich dokumentanzahl und Speichernutzung.

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

Parameter

index_name

str

Erforderlich

Der Name des abzurufenden Indexes.

Gibt zurück

Statistiken für den angegebenen Index, einschließlich Dokumentanzahl und Speichernutzung.

Rückgabetyp

Dict

Ausnahmen

HttpResponseError

get_search_client

Zurückgeben eines Clients zum Ausführen von Vorgängen in der Suche

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

Parameter

index_name

str

Erforderlich

Der Name des Suchindex

Gibt zurück

SearchClient-Objekt

Rückgabetyp

SearchClient

Ausnahmen

HttpResponseError

get_service_statistics

Abrufen von Dienstebenenstatistiken für einen Suchdienst.

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

Gibt zurück

Ergebnis der Dienststatistik.

Rückgabetyp

dict

Ausnahmen

HttpResponseError

get_synonym_map

Abrufen einer benannten Synonymzuordnung in einer Azure-Suchdienst

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

Parameter

name

str

Erforderlich

Der Name der abzurufenden Synonymzuordnung

Gibt zurück

Die abgerufene Synonymzuordnung

Rückgabetyp

SynonymMap

Ausnahmen

ResourceNotFoundError

Beispiele

Abrufen einer Synonymzuordnung

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

get_synonym_map_names

Listet die Synonymzuordnungsnamen in einer Azure-Suchdienst auf.

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

Gibt zurück

Liste der Synonymzuordnungen

Rückgabetyp

list[str]

Ausnahmen

HttpResponseError

get_synonym_maps

Listen Sie die Synonymzuordnungen in einer Azure-Suchdienst auf.

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

Parameter

select

list[str]

Wählt aus, welche Eigenschaften der obersten Ebene der Skillsets abgerufen werden sollen. Wird als Liste von JSON-Eigenschaftennamen oder "*" für alle Eigenschaften angegeben. Der Standardwert sind alle Eigenschaften.

Gibt zurück

Liste der Synonymzuordnungen

Rückgabetyp

list[SynonymMap]

Ausnahmen

HttpResponseError

Beispiele

Listen von Synonymzuordnungen

   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_index_names

Listen Sie die Indexnamen in einer Azure-Suchdienst auf.

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

Gibt zurück

Liste der Indexnamen

Rückgabetyp

ItemPaged[str]

Ausnahmen

HttpResponseError

list_indexes

Listen Sie die Indizes in einer Azure-Suchdienst auf.

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

Parameter

select

list[str]

Wählt aus, welche Eigenschaften der obersten Ebene der Skillsets abgerufen werden sollen. Wird als Liste von JSON-Eigenschaftennamen oder "*" für alle Eigenschaften angegeben. Der Standardwert sind alle Eigenschaften.

Gibt zurück

Liste der Indizes

Rückgabetyp

ItemPaged[SearchIndex]

Ausnahmen

HttpResponseError