SearchIndexClient Classe

Mostra come un analizzatore suddivide il testo nei token.

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

Parametri

Restituisce

AnalyzeResult

Tipo restituito

Eccezioni

Esempio

Analizzare il testo

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

Chiudere la SearchIndexClient sessione.

close() -> None

Eccezioni

Crea un nuovo indice di ricerca.

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

Parametri

Restituisce

Indice creato

Tipo restituito

Eccezioni

Esempio

Creazione di un nuovo indice.

   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)

Crea un nuovo indice di ricerca o aggiorna un indice se esiste già.

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

Parametri

Restituisce

Indice creato o aggiornato

Tipo restituito

Eccezioni

Esempio

Aggiornare un indice.

   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)

Creare una nuova mappa sinonimo in un servizio di ricerca di Azure o aggiornare uno esistente.

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

Parametri

Restituisce

Mappa sinonimo creata o aggiornata

Tipo restituito

Eccezioni

Creare una nuova mappa sinonimo in un servizio di ricerca di Azure

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

Parametri

Restituisce

Mappa sinonimo creata

Tipo restituito

Eccezioni

Esempio

Creare una mappa sinonimo

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

Elimina un indice di ricerca e tutti i documenti contenuti. Il modello deve essere fornito anziché il nome per usare le condizioni di accesso.

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

Parametri

Eccezioni

Esempio

Eliminare un indice.

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

Eliminare una mappa sinonimo denominata in un servizio di ricerca di Azure. Per usare le condizioni di accesso, è necessario specificare il modello SynonymMap anziché il nome. È sufficiente specificare il nome della mappa sinonimo per eliminare in modo incondizionato.

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

Parametri

Restituisce

Nessuno

Tipo restituito

Eccezioni

Esempio

Eliminare una mappa sinonimo

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

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

Parametri

Restituisce

Oggetto SearchIndex

Tipo restituito

Eccezioni

Esempio

Ottenere un indice.

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

Restituisce le statistiche per l'indice specificato, incluso un conteggio dei documenti e l'utilizzo dell'archiviazione.

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

Parametri

Restituisce

Statistiche per l'indice specificato, incluso un conteggio dei documenti e l'utilizzo dell'archiviazione.

Tipo restituito

Eccezioni

Restituire un client per eseguire operazioni su Ricerca

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

Parametri

Restituisce

Oggetto SearchClient

Tipo restituito

Eccezioni

Ottenere statistiche a livello di servizio per un servizio di ricerca.

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

Restituisce

Risultato delle statistiche del servizio.

Tipo restituito

Eccezioni

Recuperare una mappa sinonimo denominata in un servizio di ricerca di Azure

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

Parametri

Restituisce

Mappa sinonimo recuperata

Tipo restituito

Eccezioni

Esempio

Ottenere una mappa sinonimo

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

Elencare i nomi della mappa sinonimi in un servizio di ricerca di Azure.

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

Restituisce

Elenco di mappe sinonimi

Tipo restituito

Eccezioni

Elencare mappe sinonimi in un servizio di ricerca di Azure.

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

Parametri

Restituisce

Elenco di mappe sinonimi

Tipo restituito

Eccezioni

Esempio

Elencare mappe sinonimi

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

Elencare i nomi di indice in un servizio di ricerca di Azure.

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

Restituisce

Elenco dei nomi di indice

Tipo restituito

Eccezioni

Elencare gli indici in un servizio di ricerca di Azure.

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

Parametri

Restituisce

Elenco di indici

Tipo restituito

Eccezioni