SearchIndexClient Classe

Un client per interagire con l'indice del servizio di ricerca di Azure.

Ereditarietà

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Costruttore

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

Parametri

endpoint

str

Necessario

Endpoint URL di un servizio di ricerca di Azure

credential

AzureKeyCredential oppure TokenCredential

Necessario

Credenziali per autorizzare le richieste client di ricerca

api_version

str

Versione dell'API di ricerca da usare per le richieste.

audience

str

imposta Il gruppo di destinatari da usare per l'autenticazione con Azure Active Directory (AAD). Il gruppo di destinatari non viene considerato quando si usa una chiave condivisa. Se il pubblico non viene fornito, verrà assunto il pubblico del cloud.

Metodi

analyze_text	Mostra come un analizzatore suddivide il testo nei token.
close	Chiudere la SearchIndexClient sessione.
create_index	Crea un nuovo indice di ricerca.
create_or_update_index	Crea un nuovo indice di ricerca o aggiorna un indice se esiste già.
create_or_update_synonym_map	Creare una nuova mappa sinonimo in un servizio di ricerca di Azure o aggiornare uno esistente.
create_synonym_map	Creare una nuova mappa sinonimo in un servizio di ricerca di Azure
delete_index	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_synonym_map	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.
get_index
get_index_statistics	Restituisce le statistiche per l'indice specificato, incluso un conteggio dei documenti e l'utilizzo dell'archiviazione.
get_search_client	Restituire un client per eseguire operazioni su Ricerca
get_service_statistics	Ottenere statistiche a livello di servizio per un servizio di ricerca.
get_synonym_map	Recuperare una mappa sinonimo denominata in un servizio di ricerca di Azure
get_synonym_map_names	Elencare i nomi della mappa sinonimi in un servizio di ricerca di Azure.
get_synonym_maps	Elencare mappe sinonimi in un servizio di ricerca di Azure.
list_index_names	Elencare i nomi di indice in un servizio di ricerca di Azure.
list_indexes	Elencare gli indici in un servizio di ricerca di Azure.

analyze_text

Mostra come un analizzatore suddivide il testo nei token.

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

Parametri

index_name

str

Necessario

Nome dell'indice per cui testare un analizzatore.

analyze_request

AnalyzeTextOptions

Necessario

Componenti di testo e analizzatore o analisi da testare.

Restituisce

AnalyzeResult

Tipo restituito

AnalyzeResult

Eccezioni

HttpResponseError

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

close

Chiudere la SearchIndexClient sessione.

close() -> None

Eccezioni

HttpResponseError

create_index

Crea un nuovo indice di ricerca.

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

Parametri

index

SearchIndex

Necessario

Oggetto index.

Restituisce

Indice creato

Tipo restituito

SearchIndex

Eccezioni

HttpResponseError

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)

create_or_update_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

index

SearchIndex

Necessario

Oggetto index.

allow_index_downtime

bool

Necessario

Consente l'aggiunta di nuovi analizzatori, tokenizzatori, filtri token o filtri char a un indice prendendo offline l'indice per almeno alcuni secondi. Ciò causa temporaneamente l'indicizzazione e le richieste di query hanno esito negativo. Le prestazioni e la disponibilità alla scrittura dell'indice possono risultare inferiori per vari minuti dopo che l'indice è stato aggiornato o più a lungo per gli indici molto grandi.

match_condition

MatchConditions

Condizione di corrispondenza da usare sul etag

Restituisce

Indice creato o aggiornato

Tipo restituito

SearchIndex

Eccezioni

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

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)

create_or_update_synonym_map

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

synonym_map

SynonymMap

Necessario

Oggetto Map sinonimo

match_condition

MatchConditions

Condizione di corrispondenza da usare sul etag

Restituisce

Mappa sinonimo creata o aggiornata

Tipo restituito

SynonymMap

Eccezioni

HttpResponseError

create_synonym_map

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

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

Parametri

synonym_map

SynonymMap

Necessario

Oggetto Map sinonimo

Restituisce

Mappa sinonimo creata

Tipo restituito

SynonymMap

Eccezioni

HttpResponseError

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

delete_index

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

index

str oppure SearchIndex

Necessario

Nome dell'indice o oggetto da eliminare.

match_condition

MatchConditions

Condizione di corrispondenza da usare sul etag

Eccezioni

HttpResponseError

Esempio

Eliminare un indice.

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

delete_synonym_map

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

name

str oppure SynonymMap

Necessario

Nome mappa sinonimo o oggetto da eliminare

match_condition

MatchConditions

Condizione di corrispondenza da usare sul etag

Restituisce

Nessuno

Tipo restituito

None

Eccezioni

HttpResponseError

Esempio

Eliminare una mappa sinonimo

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

get_index

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

Parametri

name

str

Necessario

Nome dell'indice da recuperare.

Restituisce

Oggetto SearchIndex

Tipo restituito

SearchIndex

Eccezioni

HttpResponseError

Esempio

Ottenere un indice.

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

get_index_statistics

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

index_name

str

Necessario

Nome dell'indice da recuperare.

Restituisce

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

Tipo restituito

Dict

Eccezioni

HttpResponseError

get_search_client

Restituire un client per eseguire operazioni su Ricerca

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

Parametri

index_name

str

Necessario

Nome dell'indice di ricerca

Restituisce

Oggetto SearchClient

Tipo restituito

SearchClient

Eccezioni

HttpResponseError

get_service_statistics

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

dict

Eccezioni

HttpResponseError

get_synonym_map

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

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

Parametri

name

str

Necessario

Nome della mappa sinonimo da ottenere

Restituisce

Mappa sinonimo recuperata

Tipo restituito

SynonymMap

Eccezioni

ResourceNotFoundError

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

get_synonym_map_names

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

list[str]

Eccezioni

HttpResponseError

get_synonym_maps

Elencare mappe sinonimi in un servizio di ricerca di Azure.

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

Parametri

select

list[str]

Seleziona le proprietà di primo livello dei set di competenze da recuperare. Specificato come elenco di nomi di proprietà JSON o '*' per tutte le proprietà. Il valore predefinito è tutte le proprietà.

Restituisce

Elenco di mappe sinonimi

Tipo restituito

list[SynonymMap]

Eccezioni

HttpResponseError

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

list_index_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

ItemPaged[str]

Eccezioni

HttpResponseError

list_indexes

Elencare gli indici in un servizio di ricerca di Azure.

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

Parametri

select

list[str]

Seleziona le proprietà di primo livello dei set di competenze da recuperare. Specificato come elenco di nomi di proprietà JSON o '*' per tutte le proprietà. Il valore predefinito è tutte le proprietà.

Restituisce

Elenco di indici

Tipo restituito

ItemPaged[SearchIndex]

Eccezioni

HttpResponseError