SearchIndexClient Classe

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

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

Paramètres

Retours

AnalyzeResult

Type de retour

Exceptions

Exemples

Analyser le texte

   from azure.core.credentials import AzureKeyCredential
   from azure.search.documents.indexes.aio 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")

   async with client:
       result = await client.analyze_text(index_name, analyze_request)
       print(result.as_dict())

Fermez la SearchIndexClient session.

async close() -> None

Retours

None

Type de retour

Exceptions

Crée un index de recherche.

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

Paramètres

Retours

Index créé

Type de retour

Exceptions

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 = await client.create_index(index)
   await client.close()

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

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

Paramètres

Retours

Index créé ou mis à jour

Type de retour

Exceptions

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 = await client.create_or_update_index(index=index)
   await client.close()

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

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

Paramètres

Retours

Carte de synonymes créée ou mise à jour

Type de retour

Exceptions

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

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

Paramètres

Retours

Carte de synonymes créée

Type de retour

Exceptions

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 = await client.create_synonym_map(synonym_map)
   print("Create new Synonym Map 'test-syn-map succeeded")

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

async delete_index(index: str | SearchIndex, **kwargs: Any) -> None

Paramètres

Exceptions

Exemples

Supprimer un index.

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

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.

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

Paramètres

Retours

None

Type de retour

Exceptions

Exemples

Supprimer une carte de synonymes

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

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

Paramètres

Retours

Objet SearchIndex

Type de retour

Exceptions

Exemples

Obtenir un index.

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

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

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

Paramètres

Retours

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

Type de retour

Exceptions

Retourne un client pour effectuer des opérations sur la recherche.

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

Paramètres

Retours

SearchClient

Type de retour

Exceptions

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

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

Retours

Résultat des statistiques de service

Type de retour

Exceptions

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

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

Paramètres

Retours

Carte de synonymes récupérée

Type de retour

Exceptions

Exemples

Obtenir une carte de synonymes

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

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

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

Retours

Liste des noms de carte de synonymes

Type de retour

Exceptions

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

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

Paramètres

Retours

Liste des mappages de synonymes

Type de retour

Exceptions

Exemples

Lister les mappages de synonymes

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

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

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

Retours

Liste des noms d’index

Type de retour

Exceptions

Répertoriez les index dans un service Search Azure.

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

Paramètres

Retours

Liste des index

Type de retour

Exceptions