app search pythonダウンロード - app search pythonソースコードダウンロード

️このクライアントは廃止されました️
Enterprise Search バージョン 7.10.0 の時点で、ユーザーは新しい Enterprise Search Python クライアントに誘導され、このクライアントは非推奨になります。
このクライアントは、すべての Enterprise Search 7.x リリースと互換性がありますが、8.x リリースとは互換性がありません。このプロジェクトでの開発作業はバグ修正に限定されます。今後のすべての機能強化は、Enterprise Search Python クライアントに焦点を当てます。
ありがとう！ - 伸縮性のある

Elastic App Search ロゴ

Elastic App Search で優れた関連性の高い検索エクスペリエンスを構築するためのファーストパーティ Python クライアント。

コンテンツ

はじめる
依存関係
バージョン管理
使用法
テストの実行
よくある質問
貢献する
ライセンス

はじめる？

クライアントをインストールするには、pip を使用します。

 python - m pip install elastic - app - search

プロジェクトソースをダウンロードして実行することもできます::

 python setup . py install

依存関係

Python 2.7 / Python 3.3
リクエスト
PyJWT

バージョン管理

このクライアントはバージョン管理され、App Search とともにリリースされます。

互換性を保証するには、対応する App Search 実装のメジャーバージョン内でこのライブラリの最新バージョンを使用してください。

たとえば、App Search 7.3の場合は、このライブラリの7.3以降を使用します8.0は使用しません。

App Search の swiftype.com で入手可能な SaaS バージョンを使用している場合は、クライアントのバージョン 7.5.x を使用する必要があります。

使用法

クライアントのインスタンス化

このクライアントを使用する場合は、Elastic App Search のインスタンスがすでに稼働していることを前提としています。

クライアントは、 base_endpoint 、 api_key 、およびuse_httpsパラメータを使用してインスタンス化できます。

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

注:

[api_key]は API へのリクエストを認証します。クライアントでは任意のキータイプを使用できますが、それぞれの有効範囲が異なります。キーの詳細については、ドキュメントを参照してください。

base_endpointプロトコルを除外し、 api/as/v1プレフィックスを含める必要があります。これは通常、App Search ダッシュボード内の [資格情報] タブにあります。

サーバーの構成に応じて、 use_https TrueまたはFalseに設定します。多くの場合、 localhostで開発環境で実行している場合はFalseになり、実稼働環境ではTrueになります。

以下は、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
)

Swiftype.com アプリ検索ユーザー:

App Search の swiftype.com で入手可能な SaaS バージョンを使用する場合、 base_endpointパラメーターの代わりにhost_identifierを使用してクライアントを構成できます。 host_identifierは、[認証情報] メニュー内にあります。

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

インデックス作成: 単一ドキュメントの作成または更新

 >> > 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' }

インデックス作成: 複数のドキュメントの作成または更新

 >> > 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' : []}]

インデックス作成: ドキュメントの更新 (部分更新)

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

>> > client . update_documents ( engine_name , documents )

ドキュメントの取得

 >> > 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.' }]

ドキュメントのリスト

 >> > 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.' }]
}

文書の破棄

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

スキーマの取得

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

スキーマの作成/更新

 >> > 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' }

リストエンジン

 >> > 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' }]
}

エンジンを入手する

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

エンジンを作成する

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

エンジンを破壊する

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

エンジン内のすべての同義語セットをリストする

デフォルトのページネーション (ページサイズ 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'
      ]
    }
  ]
}

カスタムページネーションあり

 >> > 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'
      ]
    }
  ]
}

単一の同義語セットを取得する

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

同義語セットを作成する

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

同義語セットを更新する

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

同義語セットを破棄する

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

検索中

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

複数検索

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

クエリの提案

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

クリックスルー追跡

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

署名付き検索キーを作成する

本文フィールドのみを検索する検索キーを作成します。

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

メタエンジンを作成する

 >> > 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' }

ソースエンジンをメタエンジンに追加する

 >> > 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' }

メタエンジンからソースエンジンを削除する

 >> > 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' }

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

検索設定を取得する

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

検索設定を更新する

 >> > 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" : {}
}

検索設定をリセットする

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

テストの実行

 python setup . py test

よくある質問？

クライアントの問題はどこに報告すればよいですか?

何かが期待どおりに動作しない場合は、問題を開いてください。

App Search について詳しくはどこで確認できますか?

最善の策は、ドキュメントを読むことです。

他にどこに行けば助けが得られますか?

Elastic App Search コミュニティのディスカッションフォーラムをチェックアウトできます。

貢献する

プロジェクトへの貢献者を歓迎します。始める前に、次の点に注意してください。

プルリクエストを開く前に、提案の範囲について議論するための問題を作成してください。
必要に応じて、単純なコードと簡潔なドキュメントを作成してください。

ライセンス？

貢献者の皆様、ありがとうございました！

拡大する

app search python