SearchIndexClient Kelas

Klien untuk berinteraksi dengan indeks layanan pencarian Azure.

Warisan

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexClient

Konstruktor

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

Parameter

endpoint

str

Diperlukan

Titik akhir URL layanan pencarian Azure

credential

AzureKeyCredential atau TokenCredential

Diperlukan

Kredensial untuk mengotorisasi permintaan klien pencarian

api_version

str

Versi Search API yang akan digunakan untuk permintaan.

audience

str

mengatur Audiens yang akan digunakan untuk autentikasi dengan Azure Active Directory (AAD). Audiens tidak dipertimbangkan saat menggunakan kunci bersama. Jika audiens tidak disediakan, audiens cloud publik akan diasumsikan.

Metode

analyze_text	Memperlihatkan bagaimana penganalisis memecah teks menjadi token.
close	SearchIndexClient Tutup sesi.
create_index	Membuat indeks pencarian baru.
create_or_update_index	Membuat indeks pencarian baru atau memperbarui indeks jika sudah ada.
create_or_update_synonym_map	Buat Peta Sinonim baru di Azure layanan Pencarian, atau perbarui yang sudah ada.
create_synonym_map	Membuat Peta Sinonim baru di Azure layanan Pencarian
delete_index	Menghapus indeks pencarian dan semua dokumen yang ada di dalamnya. Model harus disediakan alih-alih nama untuk menggunakan kondisi akses.
delete_synonym_map	Menghapus Peta Sinonim bernama di azure layanan Pencarian. Untuk menggunakan kondisi akses, model SynonymMap harus disediakan alih-alih namanya. Ini cukup untuk memberikan nama peta sinonim untuk menghapus tanpa syarat.
get_index
get_index_statistics	Mengembalikan statistik untuk indeks tertentu, termasuk jumlah dokumen dan penggunaan penyimpanan.
get_search_client	Mengembalikan klien untuk melakukan operasi pada Pencarian
get_service_statistics	Mendapatkan statistik tingkat layanan untuk layanan pencarian.
get_synonym_map	Mengambil Peta Sinonim bernama di Azure layanan Pencarian
get_synonym_map_names	Mencantumkan nama Peta Sinonim di Azure layanan Pencarian.
get_synonym_maps	Mencantumkan Peta Sinonim di layanan Pencarian Azure.
list_index_names	Mencantumkan nama indeks dalam layanan Pencarian Azure.
list_indexes	Mencantumkan indeks dalam layanan Pencarian Azure.

analyze_text

Memperlihatkan bagaimana penganalisis memecah teks menjadi token.

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

Parameter

index_name

str

Diperlukan

Nama indeks untuk menguji penganalisis.

analyze_request

AnalyzeTextOptions

Diperlukan

Teks dan penganalisis atau komponen analisis untuk diuji.

Mengembalikan

AnalyzeResult

Tipe hasil

AnalyzeResult

Pengecualian

HttpResponseError

Contoh

Analisa teks

   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 Tutup sesi.

close() -> None

Pengecualian

HttpResponseError

create_index

Membuat indeks pencarian baru.

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

Parameter

index

SearchIndex

Diperlukan

Objek indeks.

Mengembalikan

Indeks yang dibuat

Tipe hasil

SearchIndex

Pengecualian

HttpResponseError

Contoh

Membuat indeks baru.

   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

Membuat indeks pencarian baru atau memperbarui indeks jika sudah ada.

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

Parameter

index

SearchIndex

Diperlukan

Objek indeks.

allow_index_downtime

bool

Diperlukan

Memungkinkan penganalisis, tokenizer, filter token, atau filter karakter baru ditambahkan ke indeks dengan membuat indeks offline setidaknya selama beberapa detik. Ini untuk sementara menyebabkan pengindeksan dan permintaan kueri gagal. Ketersediaan performa dan tulis indeks dapat terganggu selama beberapa menit setelah indeks diperbarui, atau lebih lama untuk indeks yang sangat besar.

match_condition

MatchConditions

Kondisi kecocokan yang digunakan pada etag

Mengembalikan

Indeks dibuat atau diperbarui

Tipe hasil

SearchIndex

Pengecualian

ResourceNotFoundError

ResourceModifiedError

ResourceNotModifiedError

ResourceNotFoundError

ResourceExistsError

Contoh

Memperbarui indeks.

   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

Buat Peta Sinonim baru di Azure layanan Pencarian, atau perbarui yang sudah ada.

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

Parameter

synonym_map

SynonymMap

Diperlukan

Objek Peta Sinonim

match_condition

MatchConditions

Kondisi kecocokan yang digunakan pada etag

Mengembalikan

Peta Sinonim yang dibuat atau diperbarui

Tipe hasil

SynonymMap

Pengecualian

HttpResponseError

create_synonym_map

Membuat Peta Sinonim baru di Azure layanan Pencarian

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

Parameter

synonym_map

SynonymMap

Diperlukan

Objek Peta Sinonim

Mengembalikan

Peta Sinonim yang dibuat

Tipe hasil

SynonymMap

Pengecualian

HttpResponseError

Contoh

Membuat Peta Sinonim

   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

Menghapus indeks pencarian dan semua dokumen yang ada di dalamnya. Model harus disediakan alih-alih nama untuk menggunakan kondisi akses.

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

Parameter

index

str atau SearchIndex

Diperlukan

Nama indeks atau objek yang akan dihapus.

match_condition

MatchConditions

Kondisi kecocokan yang digunakan pada etag

Pengecualian

HttpResponseError

Contoh

Menghapus sebuah indeks.

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

delete_synonym_map

Menghapus Peta Sinonim bernama di azure layanan Pencarian. Untuk menggunakan kondisi akses, model SynonymMap harus disediakan alih-alih namanya. Ini cukup untuk memberikan nama peta sinonim untuk menghapus tanpa syarat.

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

Parameter

name

str atau SynonymMap

Diperlukan

Nama peta sinonim atau objek yang akan dihapus

match_condition

MatchConditions

Kondisi kecocokan yang digunakan pada etag

Mengembalikan

Tidak ada

Tipe hasil

None

Pengecualian

HttpResponseError

Contoh

Menghapus Peta Sinonim

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

get_index

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

Parameter

name

str

Diperlukan

Nama indeks yang akan diambil.

Mengembalikan

Objek SearchIndex

Tipe hasil

SearchIndex

Pengecualian

HttpResponseError

Contoh

Dapatkan indeks.

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

get_index_statistics

Mengembalikan statistik untuk indeks tertentu, termasuk jumlah dokumen dan penggunaan penyimpanan.

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

Parameter

index_name

str

Diperlukan

Nama indeks yang akan diambil.

Mengembalikan

Statistik untuk indeks tertentu, termasuk jumlah dokumen dan penggunaan penyimpanan.

Tipe hasil

Dict

Pengecualian

HttpResponseError

get_search_client

Mengembalikan klien untuk melakukan operasi pada Pencarian

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

Parameter

index_name

str

Diperlukan

Nama Indeks Pencarian

Mengembalikan

Objek SearchClient

Tipe hasil

SearchClient

Pengecualian

HttpResponseError

get_service_statistics

Mendapatkan statistik tingkat layanan untuk layanan pencarian.

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

Mengembalikan

Hasil statistik layanan.

Tipe hasil

dict

Pengecualian

HttpResponseError

get_synonym_map

Mengambil Peta Sinonim bernama di Azure layanan Pencarian

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

Parameter

name

str

Diperlukan

Nama Peta Sinonim yang akan didapatkan

Mengembalikan

Peta Sinonim yang diambil

Tipe hasil

SynonymMap

Pengecualian

ResourceNotFoundError

Contoh

Mendapatkan Peta Sinonim

   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

Mencantumkan nama Peta Sinonim di Azure layanan Pencarian.

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

Mengembalikan

Daftar peta sinonim

Tipe hasil

list[str]

Pengecualian

HttpResponseError

get_synonym_maps

Mencantumkan Peta Sinonim di layanan Pencarian Azure.

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

Parameter

select

list[str]

Memilih properti tingkat atas mana dari set keterampilan yang akan diambil. Ditentukan sebagai daftar nama properti JSON, atau '*' untuk semua properti. Defaultnya adalah semua properti.

Mengembalikan

Daftar peta sinonim

Tipe hasil

list[SynonymMap]

Pengecualian

HttpResponseError

Contoh

Daftar Peta Sinonim

   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

Mencantumkan nama indeks dalam layanan Pencarian Azure.

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

Mengembalikan

Daftar nama indeks

Tipe hasil

ItemPaged[str]

Pengecualian

HttpResponseError

list_indexes

Mencantumkan indeks dalam layanan Pencarian Azure.

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

Parameter

select

list[str]

Memilih properti tingkat atas mana dari set keterampilan yang akan diambil. Ditentukan sebagai daftar nama properti JSON, atau '*' untuk semua properti. Defaultnya adalah semua properti.

Mengembalikan

Daftar indeks

Tipe hasil

ItemPaged[SearchIndex]

Pengecualian

HttpResponseError