SearchIndexClient Classe

Un client pour interagir avec l’index du service de recherche Azure.

Héritage

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Constructeur

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

Paramètres

endpoint

str

Obligatoire

Point de terminaison d’URL d’un service de recherche Azure

credential

AzureKeyCredential ou TokenCredential

Obligatoire

Informations d’identification permettant d’autoriser les requêtes clientes de recherche

api_version

str

Version de l’API De recherche à utiliser pour les requêtes.

audience

str

définit l’audience à utiliser pour l’authentification avec Azure Active Directory (AAD). L’audience n’est pas prise en compte lors de l’utilisation d’une clé partagée. Si l’audience n’est pas fournie, l’audience du cloud public est supposée.

Méthodes

analyze_text	Montre comment un analyseur décompose le texte en jetons.
close	Fermez la SearchIndexClient session.
create_index	Crée un index de recherche.
create_or_update_index	Crée un index de recherche ou met à jour un index s’il existe déjà.
create_or_update_synonym_map	Créez une carte de synonymes dans un service Search Azure ou mettez à jour une carte de synonymes existante.
create_synonym_map	Créer une carte de synonymes dans un service Search Azure
delete_index	Supprime un index de recherche et tous les documents qu’il contient. Le modèle doit être fourni au lieu du nom pour utiliser les conditions d’accès.
delete_synonym_map	Supprimez une carte de synonymes nommée dans un service Search Azure. Pour utiliser des conditions d’accès, le modèle SynonymMap doit être fourni au lieu du nom. Il suffit de fournir le nom de la carte de synonymes à supprimer de manière inconditionnelle.
get_index
get_index_statistics	Retourne des statistiques pour l’index donné, y compris le nombre de documents et l’utilisation du stockage.
get_search_client	Retourner un client pour effectuer des opérations sur la recherche
get_service_statistics	Obtenez des statistiques de niveau de service pour un service de recherche.
get_synonym_map	Récupérer une carte de synonymes nommée dans un service Search Azure
get_synonym_map_names	Répertoriez les noms de la carte de synonymes dans un service Search Azure.
get_synonym_maps	Répertoriez les mappages de synonymes dans un service Search Azure.
list_index_names	Répertoriez les noms d’index dans un service Search Azure.
list_indexes	Répertoriez les index dans un service Search Azure.

analyze_text

Montre comment un analyseur décompose le texte en jetons.

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

Paramètres

index_name

str

Obligatoire

Nom de l’index pour lequel tester un analyseur.

analyze_request

AnalyzeTextOptions

Obligatoire

Composants de texte et d’analyseur ou d’analyse à tester.

Retours

AnalyzeResult

Type de retour

AnalyzeResult

Exceptions

HttpResponseError

Exemples

Analyser le texte

   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

Fermez la SearchIndexClient session.

close() -> None

Exceptions

HttpResponseError

create_index

Crée un index de recherche.

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

Paramètres

index

SearchIndex

Obligatoire

Objet index.

Retours

Index créé

Type de retour

SearchIndex

Exceptions

HttpResponseError

Exemples

Création d’un 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)

create_or_update_index

Crée un index de recherche ou met à jour un index s’il existe déjà.

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

Paramètres

index

SearchIndex

Obligatoire

Objet index.

allow_index_downtime

bool

Obligatoire

Permet d’ajouter de nouveaux analyseurs, générateurs de jetons, filtres de jetons ou filtres char à un index en mettant l’index hors connexion pendant au moins quelques secondes. Cela entraîne temporairement l’échec des demandes d’indexation et de requête. Les performances et la disponibilité d’écriture de l’index peuvent être altérées pendant plusieurs minutes après la mise à jour de l’index, ou plus longtemps pour les très grands index.

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag

Retours

Index créé ou mis à jour

Type de retour

SearchIndex

Exceptions

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Exemples

Mettre à jour un 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

Créez une carte de synonymes dans un service Search Azure ou mettez à jour une carte de synonymes existante.

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

Paramètres

synonym_map

SynonymMap

Obligatoire

Objet Synonym Map

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag

Retours

Carte de synonymes créée ou mise à jour

Type de retour

SynonymMap

Exceptions

HttpResponseError

create_synonym_map

Créer une carte de synonymes dans un service Search Azure

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

Paramètres

synonym_map

SynonymMap

Obligatoire

Objet Synonym Map

Retours

Carte de synonymes créée

Type de retour

SynonymMap

Exceptions

HttpResponseError

Exemples

Créer une carte de synonymes

   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

Supprime un index de recherche et tous les documents qu’il contient. Le modèle doit être fourni au lieu du nom pour utiliser les conditions d’accès.

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

Paramètres

index

str ou SearchIndex

Obligatoire

Nom d’index ou objet à supprimer.

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag

Exceptions

HttpResponseError

Exemples

Supprimer un index.

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

delete_synonym_map

Supprimez une carte de synonymes nommée dans un service Search Azure. Pour utiliser des conditions d’accès, le modèle SynonymMap doit être fourni au lieu du nom. Il suffit de fournir le nom de la carte de synonymes à supprimer de manière inconditionnelle.

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

Paramètres

name

str ou SynonymMap

Obligatoire

Nom ou objet de mappage de synonymes à supprimer

match_condition

MatchConditions

Condition de correspondance à utiliser sur l’etag

Retours

None

Type de retour

None

Exceptions

HttpResponseError

Exemples

Supprimer une carte de synonymes

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

get_index

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

Paramètres

name

str

Obligatoire

Nom de l’index à récupérer.

Retours

Objet SearchIndex

Type de retour

SearchIndex

Exceptions

HttpResponseError

Exemples

Obtenir un index.

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

get_index_statistics

Retourne des statistiques pour l’index donné, y compris le nombre de documents et l’utilisation du stockage.

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

Paramètres

index_name

str

Obligatoire

Nom de l’index à récupérer.

Retours

Statistiques pour l’index donné, y compris le nombre de documents et l’utilisation du stockage.

Type de retour

Dict

Exceptions

HttpResponseError

get_search_client

Retourner un client pour effectuer des opérations sur la recherche

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

Paramètres

index_name

str

Obligatoire

Nom de l’index de recherche

Retours

Objet SearchClient

Type de retour

SearchClient

Exceptions

HttpResponseError

get_service_statistics

Obtenez des statistiques de niveau de service pour un service de recherche.

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

Retours

Résultat des statistiques de service.

Type de retour

dict

Exceptions

HttpResponseError

get_synonym_map

Récupérer une carte de synonymes nommée dans un service Search Azure

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

Paramètres

name

str

Obligatoire

Nom de la carte de synonymes à obtenir

Retours

Carte de synonymes récupérée

Type de retour

SynonymMap

Exceptions

ResourceNotFoundError

Exemples

Obtenir une carte de synonymes

   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

Répertoriez les noms de la carte de synonymes dans un service Search Azure.

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

Retours

Liste des mappages de synonymes

Type de retour

list[str]

Exceptions

HttpResponseError

get_synonym_maps

Répertoriez les mappages de synonymes dans un service Search Azure.

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

Paramètres

select

list[str]

Sélectionne les propriétés de niveau supérieur des ensembles de compétences à récupérer. Spécifié sous la forme d’une liste de noms de propriétés JSON ou « * » pour toutes les propriétés. La valeur par défaut est toutes les propriétés.

Retours

Liste des mappages de synonymes

Type de retour

list[SynonymMap]

Exceptions

HttpResponseError

Exemples

Lister les mappages de synonymes

   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

Répertoriez les noms d’index dans un service Search Azure.

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

Retours

Liste des noms d’index

Type de retour

ItemPaged[str]

Exceptions

HttpResponseError

list_indexes

Répertoriez les index dans un service Search Azure.

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

Paramètres

select

list[str]

Sélectionne les propriétés de niveau supérieur des ensembles de compétences à récupérer. Spécifié sous la forme d’une liste de noms de propriétés JSON ou « * » pour toutes les propriétés. La valeur par défaut est toutes les propriétés.

Retours

Liste des index

Type de retour

ItemPaged[SearchIndex]

Exceptions

HttpResponseError