SearchIndexClient Klas

Een client om te communiceren met Azure Search Service-indexen.

Overname

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Constructor

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

Parameters

endpoint

str

Vereist

Het URL-eindpunt van een Azure Search-service

credential

AzureKeyCredential of AsyncTokenCredential

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 in 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 synoniemenkaart 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 benoemde synoniemenkaart ophalen in een Azure-Search-service
get_synonym_map_names	Maak een lijst met namen van synoniemen in een Azure-Search-service.
get_synonym_maps	Geef het synoniem Maps 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.

async 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 analyseonderdelen die moeten worden getest.

Retouren

AnalyzeResult

Retourtype

<xref:azure.search.documents.indexes.models.AnalyzeRequest>

Uitzonderingen

HttpResponseError

Voorbeelden

Tekst analyseren

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

close

Sluit de SearchIndexClient sessie.

async close() -> None

Retouren

Geen

Retourtype

None

Uitzonderingen

HttpResponseError

create_index

Hiermee maakt u een nieuwe zoekindex.

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

create_or_update_index

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

async 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 charfilters aan een index worden toegevoegd door de index minstens een paar seconden offline te halen. Dit zorgt er tijdelijk voor dat indexerings- en queryaanvragen mislukken. De prestaties en schrijfbaarheid van de index kunnen enkele minuten nadat de index is bijgewerkt, of langer voor zeer grote indexen worden beïnvloed.

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

create_or_update_synonym_map

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

async 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 synoniemenkaart maken in een Azure-Search-service

async 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 = await 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

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

Parameters

index

SearchIndex

Vereist

De indexnaam of het object dat u wilt verwijderen.

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"
   await client.delete_index(name)
   await client.close()

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.

async 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 u wilt verwijderen

match_condition

MatchConditions

De overeenkomstvoorwaarde die moet worden gebruikt voor de etag

Retouren

Geen

Retourtype

None

Uitzonderingen

HttpResponseError

Voorbeelden

Een synoniemenkaart verwijderen

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

get_index

async 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 = await client.get_index(name)
   await client.close()

get_index_statistics

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

async 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

Retourtype

SearchClient

Uitzonderingen

HttpResponseError

get_service_statistics

Statistieken op serviceniveau ophalen voor een zoekservice.

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

Retouren

Resultaat van servicestatistieken

Retourtype

dict

Uitzonderingen

HttpResponseError

get_synonym_map

Een benoemde synoniemenkaart ophalen in een Azure-Search-service

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

Parameters

name

str

Vereist

De naam van de synoniemtoewijzing die u wilt ophalen

Retouren

De opgehaalde synoniemenkaart

Retourtype

SynonymMap

Uitzonderingen

ResourceNotFoundError

Voorbeelden

Een synoniemenkaart ophalen

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

get_synonym_map_names

Maak een lijst met namen van synoniemen in een Azure-Search-service.

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

Retouren

Lijst met synoniemenkaartnamen

Retourtype

List[str]

Uitzonderingen

HttpResponseError

get_synonym_maps

Geef het synoniem Maps weer in een Azure-Search-service.

async 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 = await 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) -> AsyncItemPaged[str]

Retouren

Lijst met indexnamen

Retourtype

AsyncItemPaged[str]

Uitzonderingen

HttpResponseError

list_indexes

De indexen in een Azure-Search-service weergeven.

list_indexes(*, select: List[str] | None = None, **kwargs) -> AsyncItemPaged[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

AsyncItemPaged[SearchIndex]

Uitzonderingen

HttpResponseError