SearchIndexClient Klass

En klient för att interagera med Azure Search-tjänstindex.

Arv

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Konstruktor

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

Parametrar

endpoint

str

Obligatorisk

URL-slutpunkten för en Azure Search-tjänst

credential

AzureKeyCredential eller TokenCredential

Obligatorisk

En autentiseringsuppgift för att auktorisera sökklientbegäranden

api_version

str

Den Search API-version som ska användas för begäranden.

audience

str

anger vilken målgrupp som ska användas för autentisering med Azure Active Directory (AAD). Målgruppen beaktas inte när du använder en delad nyckel. Om målgruppen inte tillhandahålls antas målgruppen för det offentliga molnet.

Metoder

analyze_text	Visar hur ett analysverktyg delar upp text i token.
close	SearchIndexClient Stäng sessionen.
create_index	Skapar ett nytt sökindex.
create_or_update_index	Skapar ett nytt sökindex eller uppdaterar ett index om det redan finns.
create_or_update_synonym_map	Skapa en ny synonymkarta i en Azure-tjänsten Search eller uppdatera en befintlig mappning.
create_synonym_map	Skapa en ny synonymkarta i en Azure-tjänsten Search
delete_index	Tar bort ett sökindex och alla dokument som det innehåller. Modellen måste anges i stället för namnet för att åtkomstvillkoren ska kunna användas.
delete_synonym_map	Ta bort en namngiven synonymkarta i en Azure-tjänsten Search. Om du vill använda åtkomstvillkor måste SynonymMap-modellen anges i stället för namnet. Det räcker att ange namnet på synonymkartan för att ta bort villkorslöst.
get_index
get_index_statistics	Returnerar statistik för det angivna indexet, inklusive ett antal dokument och lagringsanvändning.
get_search_client	Returnera en klient för att utföra åtgärder vid sökning
get_service_statistics	Hämta statistik på tjänstnivå för en söktjänst.
get_synonym_map	Hämta en namngiven synonymkarta i en Azure-tjänsten Search
get_synonym_map_names	Visa en lista över synonymmappningsnamn i en Azure-tjänsten Search.
get_synonym_maps	Visa en lista över synonymkartor i en Azure-tjänsten Search.
list_index_names	Lista indexnamnen i en Azure-tjänsten Search.
list_indexes	Lista indexen i en Azure-tjänsten Search.

analyze_text

Visar hur ett analysverktyg delar upp text i token.

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

Parametrar

index_name

str

Obligatorisk

Namnet på indexet som du vill testa ett analysverktyg för.

analyze_request

AnalyzeTextOptions

Obligatorisk

Text- och analyskomponenterna som ska testas.

Returer

AnalyzeResult

Returtyp

AnalyzeResult

Undantag

HttpResponseError

Exempel

Analysera text

   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

SearchIndexClient Stäng sessionen.

close() -> None

Undantag

HttpResponseError

create_index

Skapar ett nytt sökindex.

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

Parametrar

index

SearchIndex

Obligatorisk

Indexobjektet.

Returer

Indexet som skapats

Returtyp

SearchIndex

Undantag

HttpResponseError

Exempel

Skapa ett nytt 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

Skapar ett nytt sökindex eller uppdaterar ett index om det redan finns.

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

Parametrar

index

SearchIndex

Obligatorisk

Indexobjektet.

allow_index_downtime

bool

Obligatorisk

Gör att nya analysverktyg, tokeniserare, tokenfilter eller teckenfilter kan läggas till i ett index genom att indexet kopplas från i minst några sekunder. Detta gör tillfälligt att indexering och frågebegäranden misslyckas. Indexets prestanda- och skrivtillgänglighet kan försämras i flera minuter efter att indexet har uppdaterats eller längre för mycket stora index.

match_condition

MatchConditions

Matchningsvillkoret som ska användas på etag

Returer

Indexet som skapats eller uppdaterats

Returtyp

SearchIndex

Undantag

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Exempel

Uppdatera ett 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

Skapa en ny synonymkarta i en Azure-tjänsten Search eller uppdatera en befintlig mappning.

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

Parametrar

synonym_map

SynonymMap

Obligatorisk

Synonymmappningsobjektet

match_condition

MatchConditions

Matchningsvillkoret som ska användas på etag

Returer

Den skapade eller uppdaterade synonymmappningen

Returtyp

SynonymMap

Undantag

HttpResponseError

create_synonym_map

Skapa en ny synonymkarta i en Azure-tjänsten Search

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

Parametrar

synonym_map

SynonymMap

Obligatorisk

Synonymmappningsobjektet

Returer

Den skapade synonymkartan

Returtyp

SynonymMap

Undantag

HttpResponseError

Exempel

Skapa en synonymkarta

   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

Tar bort ett sökindex och alla dokument som det innehåller. Modellen måste anges i stället för namnet för att åtkomstvillkoren ska kunna användas.

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

Parametrar

index

str eller SearchIndex

Obligatorisk

Indexnamnet eller objektet som ska tas bort.

match_condition

MatchConditions

Matchningsvillkoret som ska användas på etag

Undantag

HttpResponseError

Exempel

Ta bort ett index.

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

delete_synonym_map

Ta bort en namngiven synonymkarta i en Azure-tjänsten Search. Om du vill använda åtkomstvillkor måste SynonymMap-modellen anges i stället för namnet. Det räcker att ange namnet på synonymkartan för att ta bort villkorslöst.

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

Parametrar

name

str eller SynonymMap

Obligatorisk

Synonymmappningsnamnet eller objektet som ska tas bort

match_condition

MatchConditions

Matchningsvillkoret som ska användas på etag

Returer

Ingen

Returtyp

None

Undantag

HttpResponseError

Exempel

Ta bort en synonymmappning

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

get_index

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

Parametrar

name

str

Obligatorisk

Namnet på det index som ska hämtas.

Returer

SearchIndex-objekt

Returtyp

SearchIndex

Undantag

HttpResponseError

Exempel

Hämta ett index.

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

get_index_statistics

Returnerar statistik för det angivna indexet, inklusive ett antal dokument och lagringsanvändning.

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

Parametrar

index_name

str

Obligatorisk

Namnet på det index som ska hämtas.

Returer

Statistik för det angivna indexet, inklusive ett antal dokument och lagringsanvändning.

Returtyp

Dict

Undantag

HttpResponseError

get_search_client

Returnera en klient för att utföra åtgärder vid sökning

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

Parametrar

index_name

str

Obligatorisk

Namnet på sökindexet

Returer

SearchClient-objekt

Returtyp

SearchClient

Undantag

HttpResponseError

get_service_statistics

Hämta statistik på tjänstnivå för en söktjänst.

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

Returer

Resultat av tjänststatistik.

Returtyp

dict

Undantag

HttpResponseError

get_synonym_map

Hämta en namngiven synonymkarta i en Azure-tjänsten Search

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

Parametrar

name

str

Obligatorisk

Namnet på synonymmappningen som ska hämtas

Returer

Den hämtade synonymkartan

Returtyp

SynonymMap

Undantag

ResourceNotFoundError

Exempel

Hämta en synonymkarta

   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

Visa en lista över synonymmappningsnamn i en Azure-tjänsten Search.

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

Returer

Lista över synonymmappningar

Returtyp

list[str]

Undantag

HttpResponseError

get_synonym_maps

Visa en lista över synonymkartor i en Azure-tjänsten Search.

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

Parametrar

select

list[str]

Väljer vilka egenskaper på den översta nivån för de kompetensuppsättningar som ska hämtas. Anges som en lista över JSON-egenskapsnamn eller *för alla egenskaper. Standardvärdet är alla egenskaper.

Returer

Lista över synonymmappningar

Returtyp

list[SynonymMap]

Undantag

HttpResponseError

Exempel

Lista synonymkartor

   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

Lista indexnamnen i en Azure-tjänsten Search.

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

Returer

Lista över indexnamn

Returtyp

ItemPaged[str]

Undantag

HttpResponseError

list_indexes

Lista indexen i en Azure-tjänsten Search.

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

Parametrar

select

list[str]

Väljer vilka egenskaper på den översta nivån för de kompetensuppsättningar som ska hämtas. Anges som en lista över JSON-egenskapsnamn eller *för alla egenskaper. Standardvärdet är alla egenskaper.

Returer

Lista över index

Returtyp

ItemPaged[SearchIndex]

Undantag

HttpResponseError