swiftype-app-search 0.1.0

Instantiating a client

>>> from swiftype_app_search import Client
>>> account_host_key = 'host-c5s2mj'
>>> api_key = 'api-mu75psc5egt9ppzuycnc2mc3'
>>> client = Client(account_host_key, api_key)

Index documents

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

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

Destroy Documents

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

List Engines

>>> client.list_engines()
[{'name': 'favorite-videos'}, {'name': 'another-engine'}]

Get an Engine

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

Create an Engine

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

Destroy an Engine

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

Search

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

Create a Signed Search Key

Creating a search key that will only search over the body field.

>>> api_key = 'api-mu75psc5egt9ppzuycnc2mc3'
>>> api_key_id = '42'
>>> signed_search_key = Client.create_signed_search_key(api_key, api_key_id, {'search_fields': { 'body': {}}})
>>> client = Client(account_host_key, signed_search_key)