SearchIndexClient Klas

Een client om te communiceren met de Index van de Azure Search-service.

Overname

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Constructor

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

Parameters

endpoint

str

Vereist

Het URL-eindpunt van een Azure Search-service

credential

AzureKeyCredential of TokenCredential

Vereist

Een referentie voor het autoriseren van zoekclientaanvragen

api_version

str

De search-API-versie die moet worden gebruikt voor aanvragen.

audience

str

stelt de doelgroep in die moet worden gebruikt voor verificatie met Azure Active Directory (AAD). De doelgroep wordt niet meegenomen bij het gebruik van een gedeelde sleutel. Als er geen doelgroep wordt opgegeven, wordt uitgegaan van de doelgroep van de openbare cloud.

Methoden

analyze_text	Laat zien hoe een analyse tekst opsplitst in tokens.
close	Sluit de SearchIndexClient sessie.
create_index	Hiermee maakt u een nieuwe zoekindex.
create_or_update_index	Hiermee maakt u een nieuwe zoekindex of werkt u een index bij als deze al bestaat.
create_or_update_synonym_map	Maak een nieuwe synoniemtoewijzing in een Azure-Search-service of werk een bestaande bij.
create_synonym_map	Een nieuwe synoniemtoewijzing maken in een Azure-Search-service
delete_index	Hiermee verwijdert u een zoekindex en alle documenten die deze bevat. Het model moet worden opgegeven in plaats van de naam om de toegangsvoorwaarden te kunnen gebruiken.
delete_synonym_map	Verwijder een benoemde synoniemtoewijzing in een Azure-Search-service. Als u toegangsvoorwaarden wilt gebruiken, moet het SynonymMap-model worden opgegeven in plaats van de naam. Het is voldoende om de naam op te geven van de synoniemtoewijzing die u onvoorwaardelijk wilt verwijderen.
get_index
get_index_statistics	Retourneert statistieken voor de opgegeven index, inclusief het aantal documenten en het opslaggebruik.
get_search_client	Een client retourneren om bewerkingen uit te voeren op zoeken
get_service_statistics	Statistieken op serviceniveau ophalen voor een zoekservice.
get_synonym_map	Een benoemd synoniemenkaart ophalen in een Azure-Search-service
get_synonym_map_names	Geef de namen van synoniemen in een Azure-Search-service weer.
get_synonym_maps	Geef de synoniemenkaarten weer in een Azure Search-service.
list_index_names	De indexnamen in een Azure-Search-service weergeven.
list_indexes	De indexen in een Azure-Search-service weergeven.

analyze_text

Laat zien hoe een analyse tekst opsplitst in tokens.

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

Parameters

index_name

str

Vereist

De naam van de index waarvoor een analyse moet worden getest.

analyze_request

AnalyzeTextOptions

Vereist

De tekst- en analyse- of analyseonderdelen die moeten worden getest.

Retouren

AnalyzeResult

Retourtype

AnalyzeResult

Uitzonderingen

HttpResponseError

Voorbeelden

Tekst analyseren

   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

Sluit de SearchIndexClient sessie.

close() -> None

Uitzonderingen

HttpResponseError

create_index

Hiermee maakt u een nieuwe zoekindex.

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

Parameters

index

SearchIndex

Vereist

Het indexobject.

Retouren

De gemaakte index

Retourtype

SearchIndex

Uitzonderingen

HttpResponseError

Voorbeelden

Een nieuwe index maken.

   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

Hiermee maakt u een nieuwe zoekindex of werkt u een index bij als deze al bestaat.

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

Parameters

index

SearchIndex

Vereist

Het indexobject.

allow_index_downtime

bool

Vereist

Hiermee kunnen nieuwe analysefuncties, tokenizers, tokenfilters of char-filters worden toegevoegd aan een index door de index minstens een paar seconden offline te halen. Dit zorgt er tijdelijk voor dat indexerings- en queryaanvragen mislukken. De prestaties en schrijfmogelijkheden van de index kunnen enkele minuten nadat de index is bijgewerkt, of langer voor zeer grote indexen worden beperkt.

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

Retouren

De index die is gemaakt of bijgewerkt

Retourtype

SearchIndex

Uitzonderingen

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Voorbeelden

Een index bijwerken.

   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

Maak een nieuwe synoniemtoewijzing in een Azure-Search-service of werk een bestaande bij.

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

Parameters

synonym_map

SynonymMap

Vereist

Het object Synoniemtoewijzing

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

Retouren

De gemaakte of bijgewerkte synoniemenkaart

Retourtype

SynonymMap

Uitzonderingen

HttpResponseError

create_synonym_map

Een nieuwe synoniemtoewijzing maken in een Azure-Search-service

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

Parameters

synonym_map

SynonymMap

Vereist

Het object Synoniemtoewijzing

Retouren

De gemaakte synoniemenkaart

Retourtype

SynonymMap

Uitzonderingen

HttpResponseError

Voorbeelden

Een synoniemenkaart maken

   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

Hiermee verwijdert u een zoekindex en alle documenten die deze bevat. Het model moet worden opgegeven in plaats van de naam om de toegangsvoorwaarden te kunnen gebruiken.

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

Parameters

index

str of SearchIndex

Vereist

De indexnaam of het te verwijderen object.

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

Uitzonderingen

HttpResponseError

Voorbeelden

Een index verwijderen.

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

delete_synonym_map

Verwijder een benoemde synoniemtoewijzing in een Azure-Search-service. Als u toegangsvoorwaarden wilt gebruiken, moet het SynonymMap-model worden opgegeven in plaats van de naam. Het is voldoende om de naam op te geven van de synoniemtoewijzing die u onvoorwaardelijk wilt verwijderen.

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

Parameters

name

str of SynonymMap

Vereist

De naam of het object van de synoniemtoewijzing dat moet worden verwijderd

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

Retouren

Geen

Retourtype

None

Uitzonderingen

HttpResponseError

Voorbeelden

Een synoniemenkaart verwijderen

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

get_index

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

Parameters

name

str

Vereist

De naam van de index die moet worden opgehaald.

Retouren

SearchIndex-object

Retourtype

SearchIndex

Uitzonderingen

HttpResponseError

Voorbeelden

Een index ophalen.

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

get_index_statistics

Retourneert statistieken voor de opgegeven index, inclusief het aantal documenten en het opslaggebruik.

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

Parameters

index_name

str

Vereist

De naam van de index die moet worden opgehaald.

Retouren

Statistieken voor de opgegeven index, inclusief het aantal documenten en het opslaggebruik.

Retourtype

Dict

Uitzonderingen

HttpResponseError

get_search_client

Een client retourneren om bewerkingen uit te voeren op zoeken

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

Parameters

index_name

str

Vereist

De naam van de zoekindex

Retouren

SearchClient-object

Retourtype

SearchClient

Uitzonderingen

HttpResponseError

get_service_statistics

Statistieken op serviceniveau ophalen voor een zoekservice.

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

Retouren

Resultaat van servicestatistieken.

Retourtype

dict

Uitzonderingen

HttpResponseError

get_synonym_map

Een benoemd synoniemenkaart ophalen in een Azure-Search-service

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

Parameters

name

str

Vereist

De naam van de synoniemtoewijzing die moet worden weergegeven

Retouren

De opgehaalde synoniemenkaart

Retourtype

SynonymMap

Uitzonderingen

ResourceNotFoundError

Voorbeelden

Een synoniemenkaart ophalen

   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

Geef de namen van synoniemen in een Azure-Search-service weer.

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

Retouren

Lijst met synoniemenkaarten

Retourtype

list[str]

Uitzonderingen

HttpResponseError

get_synonym_maps

Geef de synoniemenkaarten weer in een Azure Search-service.

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

Parameters

select

list[str]

Selecteert welke eigenschappen op het hoogste niveau van de vaardighedensets moeten worden opgehaald. Opgegeven als een lijst met JSON-eigenschapsnamen, of '*' voor alle eigenschappen. De standaardwaarde is alle eigenschappen.

Retouren

Lijst met synoniemenkaarten

Retourtype

list[SynonymMap]

Uitzonderingen

HttpResponseError

Voorbeelden

Lijst synoniemenkaarten

   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

De indexnamen in een Azure-Search-service weergeven.

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

Retouren

Lijst met indexnamen

Retourtype

ItemPaged[str]

Uitzonderingen

HttpResponseError

list_indexes

De indexen in een Azure-Search-service weergeven.

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

Parameters

select

list[str]

Selecteert welke eigenschappen op het hoogste niveau van de vaardighedensets moeten worden opgehaald. Opgegeven als een lijst met JSON-eigenschapsnamen, of '*' voor alle eigenschappen. De standaardwaarde is alle eigenschappen.

Retouren

Lijst met indexen

Retourtype

ItemPaged[SearchIndex]

Uitzonderingen

HttpResponseError