Beranda>Terkait pemrograman>Kode sumber lainnya
Unduh

️ Klien ini tidak digunakan lagi ️

Mulai Enterprise Search versi 7.10.0, kami mengarahkan pengguna ke Klien Python Enterprise Search yang baru dan menghentikan penggunaan klien ini.

Klien ini akan kompatibel dengan semua rilis Enterprise Search 7.x, namun tidak akan kompatibel dengan rilis 8.x. Upaya pengembangan kami pada proyek ini akan terbatas pada perbaikan bug. Semua peningkatan di masa depan akan difokuskan pada Klien Python Pencarian Perusahaan.

Terima kasih! - elastis

Logo Pencarian Aplikasi Elastis

Klien Python pihak pertama untuk membangun pengalaman pencarian yang sangat baik dan relevan dengan Elastic App Search.

Isi

  • Memulai
  • Ketergantungan
  • Pembuatan versi
  • Penggunaan
  • Menjalankan tes
  • Pertanyaan Umum
  • Menyumbang
  • Lisensi

Memulai?

Untuk menginstal klien, gunakan pip: 

 python - m pip install elastic - app - search

Anda juga dapat mengunduh sumber proyek dan menjalankan :: 

 python setup . py install

Ketergantungan

  • Piton 2.7 / Python 3.3
  • Permintaan
  • PyJWT

Pembuatan versi

Klien ini dibuat versinya dan dirilis bersamaan dengan Penelusuran Aplikasi.

Untuk menjamin kompatibilitas, gunakan versi terbaru pustaka ini dalam versi utama penerapan Penelusuran Aplikasi yang sesuai.

Misalnya, untuk App Search 7.3 , gunakan 7.3 dari pustaka ini atau yang lebih baru, tetapi bukan 8.0 .

Jika Anda menggunakan versi SaaS yang tersedia di Swiftype.com pada Pencarian Aplikasi, Anda harus menggunakan klien versi 7.5.x.

Penggunaan

Membuat instance klien

Menggunakan klien ini mengasumsikan bahwa Anda sudah memiliki instance Elastic App Search yang aktif dan berjalan.

Klien dapat dibuat instance-nya menggunakan parameter base_endpoint , api_key dan use_https : 

 >> > from elastic_app_search import Client
>> > client = Client (
    base_endpoint = 'localhost:3002/api/as/v1' ,
    api_key = 'private-mu75psc5egt9ppzuycnc2mc3' ,
    use_https = False
)

Catatan:

[api_key] mengautentikasi permintaan ke API. Anda dapat menggunakan jenis kunci apa pun dengan klien, namun masing-masing memiliki cakupan yang berbeda. Untuk informasi lebih lanjut tentang kunci, lihat dokumentasinya.

base_endpoint harus mengecualikan protokol dan menyertakan awalan api/as/v1 . Biasanya ini dapat ditemukan di tab Kredensial di Dasbor Penelusuran Aplikasi.

Setel use_https ke True atau False tergantung bagaimana server Anda dikonfigurasi. Sering kali akan menjadi False ketika dijalankan dalam pengembangan di localhost dan True untuk lingkungan produksi.

Berikut ini contoh konfigurasi untuk Elastic Cloud: 

 >> > from elastic_app_search import Client
>> > client = Client (
    base_endpoint = '77bf13bc2e9948729af339a446b06ddcc.app-search.us-east-1.aws.found.io/api/as/v1' ,
    api_key = 'private-mu75psc5egt9ppzuycnc2mc3' ,
    use_https = True
)

Pengguna Penelusuran Aplikasi Swifttype.com:

Saat menggunakan versi SaaS yang tersedia di Swiftype.com pada Penelusuran Aplikasi, Anda dapat mengonfigurasi klien menggunakan host_identifier Anda, bukan parameter base_endpoint . host_identifier dapat ditemukan dalam menu Kredensial. 

 >> > from elastic_app_search import Client
>> > host_identifier = 'host-c5s2mj'
>> > api_key = 'private-mu75psc5egt9ppzuycnc2mc3'
>> > client = Client ( host_identifier , api_key )

Pengindeksan: Membuat atau Memperbarui Satu Dokumen 

 >> > engine_name = 'favorite-videos'
>> > document = {
      'id' : 'INscMGmhmX4' ,
      'url' : 'https://www.youtube.com/watch?v=INscMGmhmX4' ,
      'title' : 'The Original Grumpy Cat' ,
      'body' : 'A wonderful video of a magnificent cat.'
    }
>> > client . index_document ( engine_name , document )
{ 'id' : 'INscMGmhmX4' }

Pengindeksan: Membuat atau Memperbarui Banyak Dokumen 

 >> > engine_name = 'favorite-videos'
>> > documents = [
    {
      'id' : 'INscMGmhmX4' ,
      'url' : 'https://www.youtube.com/watch?v=INscMGmhmX4' ,
      'title' : 'The Original Grumpy Cat' ,
      'body' : 'A wonderful video of a magnificent cat.'
    },
    {
      'id' : 'JNDFojsd02' ,
      'url' : 'https://www.youtube.com/watch?v=dQw4w9WgXcQ' ,
      'title' : 'Another Grumpy Cat' ,
      'body' : 'A great video of another cool cat.'
    }
]

>> > client . index_documents ( engine_name , documents )
[{ 'id' : 'INscMGmhmX4' , 'errors' : []}, { 'id' : 'JNDFojsd02' , 'errors' : []}]

Pengindeksan: Memperbarui dokumen (Pembaruan Sebagian) 

 >> > engine_name = 'favorite-videos'
>> > documents = [
    {
      'id' : 'INscMGmhmX4' ,
      'title' : 'Updated title'
    }
]

>> > client . update_documents ( engine_name , documents )

Dapatkan Dokumen 

 >> > engine_name = 'favorite-videos'
>> > client . get_documents ( engine_name , [ 'INscMGmhmX4' ])
[{ 'id' : 'INscMGmhmX4' , 'url' : 'https://www.youtube.com/watch?v=INscMGmhmX4' , 'title' : 'The Original Grumpy Cat' , 'body' : 'A wonderful video of a magnificent cat.' }]

Daftar Dokumen 

 >> > engine_name = 'favorite-videos'
>> > client . list_documents ( engine_name , current = 1 , size = 20 )
{
    'meta' : {
        'page' : {
        'current' : 1 ,
        'total_pages' : 1 ,
        'total_results' : 2 ,
        'size' : 20
        }
    },
    'results' : [{ 'id' : 'INscMGmhmX4' , 'url' : 'https://www.youtube.com/watch?v=INscMGmhmX4' , 'title' : 'The Original Grumpy Cat' , 'body' : 'A wonderful video of a magnificent cat.' }]
}

Hancurkan Dokumen 

 >> > engine_name = 'favorite-videos'
>> > client . destroy_documents ( engine_name , [ 'INscMGmhmX4' ])
[{ 'id' : 'INscMGmhmX4' , 'result' : True }]

Dapatkan Skema 

 >> > engine_name = 'favorite-videos'
>> > client . get_schema ( engine_name )
{ 'name' : 'text' , 'square_km' : 'number' , 'square_mi' : 'text' }

Buat/Perbarui Skema 

 >> > engine_name = 'favorite-videos'
>> > client . update_schema ( engine_name , { 'square_km' : 'text' })
{ 'square_km' : 'text' }
>> > client . update_schema ( engine_name , { 'square_mi' : 'text' })
{ 'square_km' : 'text' , 'square_mi' : 'text' }
>> > client . update_schema ( engine_name , { 'square_km' : 'number' })
{ 'square_km' : 'number' , 'square_mi' : 'text' }

Daftar Mesin 

 >> > client . list_engines ( current = 1 , size = 20 )
{
    'meta' : {
        'page' : {
        'current' : 1 ,
        'total_pages' : 1 ,
        'total_results' : 2 ,
        'size' : 20
        }
    },
    'results' : [{ 'name' : 'favorite-videos' }, { 'name' : 'another-engine' }]
}

Dapatkan Mesin 

 >> > client . get_engine ( 'favorite-videos' )
{ 'name' : 'favorite-videos' }

Buat Mesin 

 >> > client . create_engine ( 'favorite-videos' , 'en' )
{ 'name' : 'favorite-videos' , 'type' : 'default' , 'language' : 'en' }

Hancurkan Mesin 

 >> > client . destroy_engine ( 'favorite-videos' )
{ 'deleted' : True }

Daftar semua kumpulan sinonim di mesin

Dengan penomoran halaman default (ukuran halaman 20) 

 >> > client . list_synonym_sets ( 'us-national-parks' )
{
  'meta' : {
    'page' : {
      'current' : 1 ,
      'total_pages' : 1 ,
      'total_results' : 3 ,
      'size' : 20
    }
  },
  'results' : [
    {
      'id' : 'syn-5b11ac66c9f9292013220ad3' ,
      'synonyms' : [
        'park' ,
        'trail'
      ]
    },
    {
      'id' : 'syn-5b11ac72c9f9296b35220ac9' ,
      'synonyms' : [
        'protected' ,
        'heritage'
      ]
    },
    {
      'id' : 'syn-5b11ac66c9f9292013220ad3' ,
      'synonyms' : [
        'hectares' ,
        'acres'
      ]
    }
  ]
}

Dengan paginasi khusus 

 >> > client . list_synonym_sets ( 'us-national-parks' , size = 1 , current = 1 )
{
  'meta' : {
    'page' : {
      'current' : 1 ,
      'total_pages' : 3 ,
      'total_results' : 3 ,
      'size' : 1
    }
  },
  'results' : [
    {
      'id' : 'syn-5b11ac66c9f9292013220ad3' ,
      'synonyms' : [
        'park' ,
        'trail'
      ]
    }
  ]
}

Dapatkan satu set sinonim 

 >> > client . get_synonym_set ( 'us-national-parks' , 'syn-5b11ac66c9f9292013220ad3' )
{
  'id' : 'syn-5b11ac66c9f9292013220ad3' ,
  'synonyms' : [
    'park' ,
    'trail'
  ]
}

Buat kumpulan sinonim 

 >> > client . create_synonym_set ( 'us-national-parks' , [ 'park' , 'trail' ])
{
  'id' : 'syn-5b11ac72c9f9296b35220ac9' ,
  'synonyms' : [
    'park' ,
    'trail'
  ]
}

Perbarui kumpulan sinonim 

 >> > client . update_synonym_set ( 'us-national-parks' , 'syn-5b11ac72c9f9296b35220ac9' , [ 'park' , 'trail' , 'ground' ])
{
  'id' : 'syn-5b11ac72c9f9296b35220ac9' ,
  'synonyms' : [
    'park' ,
    'trail' ,
    'ground'
  ]
}

Hancurkan kumpulan sinonim 

 >> > client . destroy_synonym_set ( 'us-national-parks' , 'syn-5b11ac66c9f9292013220ad3' )
{
  'deleted' : True
}

Mencari 

 >> > client . search ( 'favorite-videos' , 'grumpy cat' , {})
{ 'meta' : { 'page' : { 'current' : 1 , 'total_pages' : 1 , 'total_results' : 2 , 'size' : 10 }, ...}, 'results' : [...]}

Multi-Pencarian 

 >> > client . multi_search ( 'favorite-videos' , [{
  'query' : 'cat' ,
  'options' : { 'search_fields' : { 'title' : {} }}
},{
  'query' : 'dog' ,
  'options' : { 'search_fields' : { 'body' : {} }}
}])
[{ 'meta' : {...}, 'results' : [...]}, { 'meta' : {...}, 'results' : [...]}]

Saran Kueri 

 >> > client . query_suggestion ( 'favorite-videos' , 'cat' , {
  'size' : 10 ,
  'types' : {
    'documents' : {
      'fields' : [ 'title' ]
    }
  }
})
{ 'results' : { 'documents' : [{ 'suggestion' : 'cat' }]}, 'meta' : { 'request_id' : '390be384ad5888353e1b32adcfaaf1c9' }}

Pelacakan Klik-tayang 

 >> > client . click ( engine_name , { 'query' : 'cat' , 'document_id' : 'INscMGmhmX4' })

Buat Kunci Pencarian yang Ditandatangani

Membuat kunci pencarian yang hanya akan mencari di kolom isi. 

 >> > api_key = 'search-xxxxxxxxxxxxxxxxxxxxxxxx'
>> > api_key_name = 'search-key' # This name must match the name of the key above from your App Search dashboard
>> > signed_search_key = Client . create_signed_search_key ( api_key , api_key_name , { 'search_fields' : { 'body' : {}}})
>> > client = Client (
    base_endpoint = 'localhost:3002/api/as/v1' ,
    api_key = signed_search_key ,
    use_https = False
)

Buat Mesin Meta 

 >> > client . create_meta_engine (
    engine_name = engine_name ,
    source_engines = [
        'source-engine-1' ,
        'source-engine-2'
    ]
)
{ 'source_engines' : [ 'source-engine-1' , 'source-engine-2' ], 'type' : 'meta' , 'name' : 'my-meta-engine' }

Tambahkan Mesin Sumber ke Mesin Meta 

 >> > client . add_meta_engine_sources ( 'my-meta-engine' , [ 'source-engine-3' ])
{ 'source_engines' : [ 'source-engine-1' , 'source-engine-2' , 'source-engine-3' ], 'type' : 'meta' , 'name' : 'my-meta-engine' }

Hapus Mesin Sumber dari Mesin Meta 

 >> > client . delete_meta_engine_sources ( 'my-meta-engine' , [ 'source-engine-3' ])
{ 'source_engines' : [ 'source-engine-1' , 'source-engine-2' ], 'type' : 'meta' , 'name' : 'my-meta-engine' }

Cari log API 

 >> > client . get_api_logs ( 'my-meta-engine' , {
  "filters" : {
    "date" : {
      "from" : "2020-03-30T00:00:00+00:00" ,
      "to" : "2020-03-31T00:00:00+00:00"
    },
    "status" : "429"
  }
})
{
    'results' : [],
    'meta' : {
        'query' : '' ,
        'filters' : {
            'date' : {
                'from' : '2020-03-27T00:00:00+00:00' ,
                'to' : '2020-03-31T00:00:00+00:00'
            },
            'status' : '429'
        },
        'sort_direction' : 'asc' ,
        'page' : {
            'current' : 1 ,
            'total_pages' : 0 ,
            'total_results' : 0 ,
            'size' : 10
        }
    }
}

Dapatkan pengaturan pencarian 

 >> > client . get_search_settings ( engine_name = 'us-national-parks' )
{
  "search_fields" : {
    "name" : {
      "weight" : 1
    },
    "description" : {
      "weight" : 1
    }
  },
  "result_fields" : {
    "name" : {
      "raw" : {}
    },
    "description" : {
      "raw" : {}
    }
  },
  "boosts" : {}
}

Perbarui pengaturan pencarian 

 >> > client . update_search_settings (
  engine_name = 'us-national-parks' ,
  search_settings = {
    "search_fields" : {
      "name" : {
        "weight" : 2
      },
      "description" : {
        "weight" : 1
      }
    },
    "result_fields" : {
      "name" : {
        "raw" : {}
      },
      "description" : {
        "raw" : {}
      }
    },
    "boosts" : {}
  }
)
{
  "search_fields" : {
    "name" : {
      "weight" : 2
    },
    "description" : {
      "weight" : 1
    }
  },
  "result_fields" : {
    "name" : {
      "raw" : {}
    },
    "description" : {
      "raw" : {}
    }
  },
  "boosts" : {}
}

Setel ulang pengaturan pencarian 

 >> > client . reset_search_settings ( engine_name = 'us-national-parks' )
{
  "search_fields" : {
    "name" : {
      "weight" : 1
    },
    "description" : {
      "weight" : 1
    }
  },
  "boosts" : {}
}

Menjalankan tes 

 python setup . py test

Pertanyaan Umum?

Di mana saya melaporkan masalah dengan klien?

Jika ada sesuatu yang tidak berfungsi seperti yang diharapkan, silakan buka masalah.

Di mana saya dapat mempelajari lebih lanjut tentang Penelusuran Aplikasi?

Taruhan terbaik Anda adalah membaca dokumentasinya.

Ke mana lagi saya bisa mendapatkan bantuan?

Anda dapat memeriksa forum diskusi komunitas Elastic App Search.

Menyumbang

Kami menyambut kontributor untuk proyek ini. Sebelum Anda mulai, beberapa catatan:

  • Sebelum membuka pull request, harap buat isu untuk mendiskusikan cakupan proposal Anda.
  • Harap tulis kode sederhana dan dokumentasi ringkas, bila perlu.

Lisensi?

Apache 2.0 © Elastis

Terima kasih kepada semua kontributor!

Memperluas
Informasi Tambahan
Aplikasi Terkait
Direkomendasikan untuk Anda
Informasi Terkait Semua