SearchIndexerClient Kelas

Referensi

Klien untuk berinteraksi dengan Pengindeks layanan pencarian Azure.

Warisan: azure.search.documents._headers_mixin.HeadersMixin

SearchIndexerClient

Konstruktor

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

close	SearchIndexerClient Tutup sesi.
create_data_source_connection	Membuat koneksi sumber data baru.
create_indexer	Membuat SearchIndexer baru.
create_or_update_data_source_connection	Membuat koneksi sumber data baru atau memperbarui koneksi sumber data jika sudah ada. :p aram data_source_connection: Definisi koneksi sumber data untuk membuat atau memperbarui. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :match_condition: Kondisi kecocokan yang digunakan pada etag :p aramtype match_condition: ~azure.core.MatchConditions :return: SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection
create_or_update_indexer	Membuat pengindeks baru atau memperbarui pengindeks jika sudah ada.
create_or_update_skillset	Buat SearchIndexerSkillset baru di azure layanan Pencarian, atau perbarui yang sudah ada.
create_skillset	Membuat SearchIndexerSkillset baru di Azure layanan Pencarian
delete_data_source_connection	Menghapus koneksi sumber data. Untuk menggunakan kondisi akses, model SearchIndexerDataSourceConnection harus disediakan alih-alih namanya. Ini cukup untuk memberikan nama koneksi sumber data untuk menghapus tanpa syarat
delete_indexer	Menghapus pengindeks. Untuk menggunakan kondisi akses, model SearchIndexer harus disediakan alih-alih namanya. Ini cukup untuk memberikan nama pengindeks untuk menghapus tanpa syarat.
delete_skillset	Hapus SearchIndexerSkillset bernama di layanan Pencarian Azure. Untuk menggunakan kondisi akses, model SearchIndexerSkillset harus disediakan alih-alih namanya. Ini cukup untuk memberikan nama set keterampilan untuk menghapus tanpa syarat
get_data_source_connection	Mengambil definisi koneksi sumber data.
get_data_source_connection_names	Mencantumkan semua nama koneksi sumber data yang tersedia untuk layanan pencarian.
get_data_source_connections	Mencantumkan semua koneksi sumber data yang tersedia untuk layanan pencarian.
get_indexer	Mengambil definisi pengindeks.
get_indexer_names	Mencantumkan semua nama pengindeks yang tersedia untuk layanan pencarian.
get_indexer_status	Dapatkan status pengindeks.
get_indexers	Mencantumkan semua pengindeks yang tersedia untuk layanan pencarian.
get_skillset	Mengambil SearchIndexerSkillset bernama di Azure layanan Pencarian
get_skillset_names	Cantumkan nama SearchIndexerSkillset di layanan Pencarian Azure.
get_skillsets	Mencantumkan SearchIndexerSkillsets di layanan Pencarian Azure.
reset_indexer	Mengatur ulang status pelacakan perubahan yang terkait dengan pengindeks.
run_indexer	Jalankan pengindeks.

close

SearchIndexerClient Tutup sesi.

close() -> None

create_data_source_connection

Membuat koneksi sumber data baru.

create_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, **kwargs: Any) -> SearchIndexerDataSourceConnection

Parameter

data_source_connection: SearchIndexerDataSourceConnection

Diperlukan

Definisi koneksi sumber data yang akan dibuat.

Mengembalikan

SearchIndexerDataSourceConnection yang dibuat

Tipe hasil

SearchIndexerDataSourceConnection

Contoh

Membuat Sumber Data


   container = SearchIndexerDataContainer(name="searchcontainer")
   data_source_connection = SearchIndexerDataSourceConnection(
       name="sample-data-source-connection", type="azureblob", connection_string=connection_string, container=container
   )
   result = client.create_data_source_connection(data_source_connection)
   print(result)
   print("Create new Data Source Connection - sample-data-source-connection")

create_indexer

Membuat SearchIndexer baru.

create_indexer(indexer: SearchIndexer, **kwargs: Any) -> SearchIndexer

Parameter

indexer: SearchIndexer

Diperlukan

Definisi pengindeks yang akan dibuat.

Mengembalikan

SearchIndexer yang dibuat

Tipe hasil

SearchIndexer

create_or_update_data_source_connection

Membuat koneksi sumber data baru atau memperbarui koneksi sumber data jika sudah ada. :p aram data_source_connection: Definisi koneksi sumber data untuk membuat atau memperbarui. :type data_source_connection: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection :match_condition: Kondisi kecocokan yang digunakan pada etag :p aramtype match_condition: ~azure.core.MatchConditions :return: SearchIndexerDataSourceConnection :rtype: ~azure.search.documents.indexes.models.SearchIndexerDataSourceConnection

create_or_update_data_source_connection(data_source_connection: SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerDataSourceConnection

create_or_update_indexer

Membuat pengindeks baru atau memperbarui pengindeks jika sudah ada.

create_or_update_indexer(indexer: SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexer

Parameter

indexer: SearchIndexer

Diperlukan

Definisi pengindeks untuk membuat atau memperbarui.

match_condition: MatchConditions

Kondisi kecocokan yang digunakan pada etag

Mengembalikan

SearchIndexer yang dibuat

Tipe hasil

SearchIndexer

create_or_update_skillset

Buat SearchIndexerSkillset baru di azure layanan Pencarian, atau perbarui yang sudah ada.

create_or_update_skillset(skillset: SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> SearchIndexerSkillset

Parameter

skillset: SearchIndexerSkillset

Diperlukan

Objek SearchIndexerSkillset untuk membuat atau memperbarui

match_condition: MatchConditions

Kondisi kecocokan yang digunakan pada etag

Mengembalikan

SearchIndexerSkillset yang dibuat atau diperbarui

Tipe hasil

SearchIndexerSkillset

create_skillset

Membuat SearchIndexerSkillset baru di Azure layanan Pencarian

create_skillset(skillset: SearchIndexerSkillset, **kwargs: Any) -> SearchIndexerSkillset

Parameter

skillset: SearchIndexerSkillset

Diperlukan

Objek SearchIndexerSkillset untuk dibuat

Mengembalikan

SearchIndexerSkillset yang dibuat

Tipe hasil

SearchIndexerSkillset

delete_data_source_connection

Menghapus koneksi sumber data. Untuk menggunakan kondisi akses, model SearchIndexerDataSourceConnection harus disediakan alih-alih namanya. Ini cukup untuk memberikan nama koneksi sumber data untuk menghapus tanpa syarat

delete_data_source_connection(data_source_connection: str | SearchIndexerDataSourceConnection, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parameter

data_source_connection: str atau SearchIndexerDataSourceConnection

Diperlukan

Koneksi sumber data yang akan dihapus.

match_condition: MatchConditions

Kondisi kecocokan yang digunakan pada etag

Mengembalikan

Tidak ada

Tipe hasil

None

Contoh

Menghapus SearchIndexerDataSourceConnection


   client.delete_data_source_connection("sample-data-source-connection")
   print("Data Source Connection 'sample-data-source-connection' successfully deleted")

delete_indexer

Menghapus pengindeks. Untuk menggunakan kondisi akses, model SearchIndexer harus disediakan alih-alih namanya. Ini cukup untuk memberikan nama pengindeks untuk menghapus tanpa syarat.

delete_indexer(indexer: str | SearchIndexer, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parameter

indexer: str atau SearchIndexer

Diperlukan

Pengindeks yang akan dihapus.

match_condition: MatchConditions

Kondisi kecocokan yang digunakan pada etag

Mengembalikan

Tidak ada

Tipe hasil

None

delete_skillset

Hapus SearchIndexerSkillset bernama di layanan Pencarian Azure. Untuk menggunakan kondisi akses, model SearchIndexerSkillset harus disediakan alih-alih namanya. Ini cukup untuk memberikan nama set keterampilan untuk menghapus tanpa syarat

delete_skillset(skillset: str | SearchIndexerSkillset, *, match_condition: MatchConditions = MatchConditions.Unconditionally, **kwargs: Any) -> None

Parameter

skillset: str atau SearchIndexerSkillset

Diperlukan

SearchIndexerSkillset untuk dihapus

match_condition: MatchConditions

Kondisi kecocokan yang digunakan pada etag

get_data_source_connection

Mengambil definisi koneksi sumber data.

get_data_source_connection(name: str, **kwargs: Any) -> SearchIndexerDataSourceConnection

Parameter

name: str

Diperlukan

Nama koneksi sumber data yang akan diambil.

Mengembalikan

SearchIndexerDataSourceConnection yang diambil.

Tipe hasil

SearchIndexerDataSourceConnection

Contoh

Mengambil SearchIndexerDataSourceConnection


   result = client.get_data_source_connection("sample-data-source-connection")
   print("Retrived Data Source Connection 'sample-data-source-connection'")

get_data_source_connection_names

Mencantumkan semua nama koneksi sumber data yang tersedia untuk layanan pencarian.

get_data_source_connection_names(**kwargs: Any) -> Sequence[str]

Mengembalikan

Daftar semua nama koneksi sumber data.

Tipe hasil

list[str]

get_data_source_connections

Mencantumkan semua koneksi sumber data yang tersedia untuk layanan pencarian.

get_data_source_connections(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexerDataSourceConnection]

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 semua koneksi sumber data.

Tipe hasil

list[SearchIndexerDataSourceConnection]

Contoh

Mencantumkan semua SearchIndexerDataSourceConnections


   result = client.get_data_source_connections()
   names = [ds.name for ds in result]
   print("Found {} Data Source Connections in the service: {}".format(len(result), ", ".join(names)))

get_indexer

Mengambil definisi pengindeks.

get_indexer(name: str, **kwargs: Any) -> SearchIndexer

Parameter

name: str

Diperlukan

Nama pengindeks yang akan diambil.

Mengembalikan

SearchIndexer yang diambil.

Tipe hasil

SearchIndexer

get_indexer_names

Mencantumkan semua nama pengindeks yang tersedia untuk layanan pencarian.

get_indexer_names(**kwargs: Any) -> Sequence[str]

Mengembalikan

Daftar semua SearchIndexers.

Tipe hasil

list[str]

get_indexer_status

Dapatkan status pengindeks.

get_indexer_status(name: str, **kwargs: Any) -> SearchIndexerStatus

Parameter

name: str

Diperlukan

Nama pengindeks untuk mengambil status.

Mengembalikan

SearchIndexerStatus

Tipe hasil

SearchIndexerStatus

get_indexers

Mencantumkan semua pengindeks yang tersedia untuk layanan pencarian.

get_indexers(*, select: List[str] | None = None, **kwargs: Any) -> Sequence[SearchIndexer]

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 semua SearchIndexers.

Tipe hasil

list[SearchIndexer]

get_skillset

Mengambil SearchIndexerSkillset bernama di Azure layanan Pencarian

get_skillset(name: str, **kwargs: Any) -> SearchIndexerSkillset

Parameter

name: str

Diperlukan

Nama SearchIndexerSkillset yang akan didapatkan

Mengembalikan

SearchIndexerSkillset yang diambil

Tipe hasil

SearchIndexerSkillset

Pengecualian

ResourceNotFoundError

get_skillset_names

Cantumkan nama SearchIndexerSkillset di layanan Pencarian Azure.

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

Mengembalikan

Daftar nama SearchIndexerSkillset

Tipe hasil

list[str]

Pengecualian

HttpResponseError

get_skillsets

Mencantumkan SearchIndexerSkillsets di layanan Pencarian Azure.

get_skillsets(*, select: List[str] | None = None, **kwargs: Any) -> List[SearchIndexerSkillset]

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 SearchIndexerSkillsets

Tipe hasil

list[SearchIndexerSkillset]

Pengecualian

HttpResponseError

reset_indexer

Mengatur ulang status pelacakan perubahan yang terkait dengan pengindeks.

reset_indexer(name: str, **kwargs: Any) -> None

Parameter

name: str

Diperlukan

Nama pengindeks yang akan direset.

Mengembalikan

Tidak ada

Tipe hasil

None

run_indexer

Jalankan pengindeks.

run_indexer(name: str, **kwargs: Any) -> None

Parameter

name: str

Diperlukan

Nama pengindeks yang akan dijalankan.

Mengembalikan

Tidak ada

Tipe hasil

None