Swiftype Python Client
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
fixtures Migrate VCR cassettes to new format Jul 11, 2017
swiftype
tests
.gitignore
.travis.yml
LICENSE.txt
README.md
setup.py Prefer six instead of future, as it is more obvious without resorting… Apr 30, 2018
test_requirements.txt
tox.ini Use a testing matrix and run the tests with tox Apr 30, 2018

README.md

Python Client for Swiftype Site Search API

Build Status

Note: This client has been developed for the Swiftype Site Search API endpoints only. You may refer to the Swiftype Site Search API Documentation for additional context.

Quickstart

Installation

You can install the latest version of the Swiftype client using pip:

pip install swiftype

To install locally, clone this repository, cd into the directory and run:

python setup.py install

Setup

  1. Create an account at Swiftype and get your API key from your Account Settings.

  2. Configure your client:

     from swiftype import swiftype
     client = swiftype.Client(api_key='YOUR_API_KEY')
    
  3. Create an Engine named e.g. youtube:

     engine = client.create_engine('youtube')
    
  4. Create your DocumentTypes:

     client.create_document_type('youtube', 'videos');
     client.create_document_type('youtube', 'channels');
    

Indexing

Now you need to create your Documents. It's very important to think about the type of each field you create a Document. The DocumentType the Document belongs to will remember each fields type and it is not possible to change it. The type specifies a fields features and you should choose them wisely. For details please have a look at our Field Types Documentation.

Add a Document to the videos DocumentType:

client.create_document('youtube', 'videos', {
	'external_id':  'external_id1',
	'fields': [
		{'name': 'title', 'value': 'Swiftype Demo', 'type': 'string'},
		{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search'], 'type': 'string'},
		{'name': 'url', 'value': 'http://www.youtube.com/watch?v=pITuOcGgpBs', 'type': 'enum'},
		{'name': 'category', 'value': ['Tutorial', 'Product'], 'type': 'enum'},
		{'name': 'publication_date', 'value': '2012-05-08T12:07Z', 'type': 'date'},
		{'name': 'likes', 'value': 31, 'type': 'integer'},
		{'name': 'length', 'value': 1.50, 'type': 'float'}
	]})

Add a Document to the users DocumentType:

client.create_document('youtube', 'channels', {
	'external_id': 'external_id1',
	'fields': [
		{'name': 'title', 'value': 'Swiftype', 'type': 'string'},
		{'name': 'url', 'value': 'http://www.youtube.com/user/swiftype', 'type': 'enum'},
		{'name': 'video_views', 'value': 15678, 'type': 'integer'},
		{'name': 'video_counts', 'value': 6, 'type': 'integer'}
	]})

Searching

Now your Engine is ready to receive queries. By default, search queries will match any fields that are of type string or text. You can search each DocumentType individually:

video_results = client.search_document_type('youtube', 'videos', 'swiftype')
channel_results = client.search_document_type('youtube', 'channels', 'swiftype')

or search all DocumentTypes on your Engine at once:

results = client.search('youtube', 'swiftype')

Autocomplete

Finally, as with full-text searches, you may perform autocomplete-style (prefix match) searches as well:

results = client.suggest('youtube', 'swi')

or

results = client.suggest_document_type('youtube', 'videos', 'swi')

API Documentation

Configuration:

Before issuing commands to the API, configure the client with your API key:

import swiftype
client = swiftype.Client(api_key='YOUR_API_KEY')

You can find your API key in your Account Settings.

Search

If you want to search for e.g. swiftype on your Engine, you can use:

results = client.search('youtube', 'swiftype')

To limit the search to only the videos DocumentType:

results = client.search_document_type('youtube', 'videos', 'swiftype')

Both search methods allow you to specify options as an extra parameter to e.g. filter or sort on fields. For more details on these options please have a look at the Search Options. Here is an example for showing only videos that are in the category Tutorial:

results = client.search_document_type('youtube', 'videos', 'swiftype', {'filters': {'videos': {'category': 'Tutorial'}}})

Autocomplete

Autocompletes have the same functionality as searches. You can autocomplete using all documents:

results = client.suggest('youtube', 'swi')

or just for one DocumentType:

results = client.suggest_document_type('youtube', 'videos', 'swi')

or add options to have more control over the results:

results = client.suggest('youtube', 'swi', {'sort_field': {'videos': 'likes'}})

Engines

Retrieve every Engine:

engines = client.engines

Create a new Engine with the name youtube:

engine = client.create_engine('youtube')

Retrieve an Engine by slug or id:

engine = client.engine('youtube')

To delete an Engine you need the slug or the id field of an engine:

client.destroy_engine('youtube')

Document Types

Retrieve DocumentTypess of the Engine with the slug field youtube:

document_types = client.document_types('youtube')

Show the second batch of documents:

document_types = client.document_types('youtube', 2)

Create a new DocumentType for an Engine with the name videos:

document_type = client.create_document_type('youtube', 'videos')

Retrieve an DocumentType by slug or id:

document_type = client.document_type('youtube', 'videos')

Delete a DocumentType using the slug or id of it:

client.destroy_document_type('youtube', 'videos')

Documents

Retrieve all Documents of Engine youtube and DocumentType videos:

documents = client.documents('youtube', 'videos')

Retrieve a specific Document using its id or external_id:

document = client.document('youtube', 'videos', 'external_id1')

Create a new Document with mandatory external_id and user-defined fields:

document = client.create_document('youtube', 'videos', {
	'external_id': 'external_id1',
		'fields': [
			{'name': 'title', 'value': 'Swiftype Demo', 'type': 'string'},
			{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search'], 'type': 'string'},
			{'name': 'url', 'value': 'http://www.youtube.com/watch?v=pITuOcGgpBs', 'type': 'enum'},
			{'name': 'category', 'value': ['Tutorial', 'Product'], 'type': 'enum'},
			{'name': 'publication_date', 'value': '2012-05-08T12:07Z', 'type': 'date'},
			{'name': 'likes', 'value': 31, 'type': 'integer'},
			{'name': 'length', 'value': 1.50, 'type': 'float'}
		]})

Create multiple Documents at once and return status for each Document creation:

stati = client.create_documents('youtube', 'videos', {
	'external_id': 'external_id1',
		'fields': [
			{'name': 'title', 'value': 'Swiftype Demo', 'type': 'string'},
			{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search'], 'type': 'string'},
			{'name': 'url', 'value': 'http://www.youtube.com/watch?v=pITuOcGgpBs', 'type': 'enum'},
			{'name': 'category', 'value': ['Tutorial', 'Product'], 'type': 'enum'},
			{'name': 'publication_date', 'value': '2012-05-08T12:07Z', 'type': 'date'},
			{'name': 'likes', 'value': 27, 'type': 'integer'},
			{'name': 'length', 'value': 1.50, 'type': 'float'}
		]},	{
	'external_id': 'external_id2',
		'fields': [
			{'name': 'title', 'value': 'Swiftype Search Wordpress Plugin Demo', 'type': 'string'},
			{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search', 'WordPress'], 'type': 'string'},
			{'name': 'url', 'value': 'http://www.youtube.com/watch?v=rukXYKEpvS4', 'type': 'enum'},
			{'name': 'category', 'value': ['Tutorial', 'Wordpress'], 'type': 'enum'},
			{'name': 'publication_date', 'value': '2012-08-15T09:07Z', 'type': 'date'},
			{'name': 'likes', 'value': 2, 'type': 'integer'},
			{'name': 'length', 'value': 2.16, 'type': 'float'}
		]})

Update fields of an existing Document specified by id or external_id:

client.update_document('youtube','videos','external_id1', {'likes': 28, 'category': ['Tutorial', 'Search']})

Update multiple Documents at once:

stati = client.update_documents('youtube', 'videos', [
	{'external_id': '2', 'fields': {'likes': 29}},
	{'external_id': '3', 'fields': {'likes': 4}}
])

Create or update a Document:

document = client.create_or_update_document('youtube', 'videos', {
	'external_id': 'external_id3',
		'fields': [
		{'name': 'title', 'value': 'Swiftype Install Type 1: Show results in an overlay', 'type': 'string'},
		{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search', 'Web'], 'type': 'string'},
		{'name': 'url', 'value': 'http://www.youtube.com/watch?v=mj2ApIx3frs', 'type': 'enum'}
	]})

Create or update multiple Documents at once:

stati = client.create_or_update_documents('youtube', 'videos', {
	'external_id': 'external_id4',
		'fields': [
			{'name': 'title', 'value': 'Swiftype Install Type 2: Show results on the current page', 'type': 'string'},
			{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search', 'Web'], 'type': 'string'},
			{'name': 'url', 'value': 'http://www.youtube.com/watch?v=6uaZXYK2WOE', 'type': 'enum'}
		]}, {
	'external_id': 'external_id5',
		'fields': [
			{'name': 'title', 'value': 'Swiftype Install Type 3: Show results on a new page', 'type': 'string'},
			{'name': 'tags', 'value': ['Swiftype', 'Search', 'Full text search', 'Web'], 'type': 'string'},
			{'name': 'url', 'value': 'http://www.youtube.com/watch?v=ebSWAscBPtc', 'type': 'enum'}
		]});

Destroy a Document:

client.destroy_document('youtube','videos','external_id5')

Destroy multiple Documents at once:

stati = client.destroy_documents('youtube','videos',['external_id2','external_id3','external_id6'])

Domains

Retrieve all Domains of Engine websites:

domains = client.domains('websites')

Retrieve a specific Domain by id:

domain = client.domain('websites', 'generated_id')

Create a new Domain with the URL https://swiftype.com and start crawling:

domain = client.create_domain('websites', 'https://swiftype.com')

Delete a Domain using its id:

client.destroy_domain('websites', 'generated_id')

Initiate a recrawl of a specific Domain using its id:

client.recrawl_domain('websites', 'generated_id')

Add or update a URL for a Domain:

client.crawl_url('websites', 'generated_id', 'https://swiftype.com/new/path/about.html')

Analytics

To get the amount of searches on your Engine in the last 14 days use:

searches = client.analytics_searches('youtube')

You can also use a specific start and/or end date:

searches = client.analytics_searches('youtube', '2013-01-01', '2013-02-01')

To get the amount of autoselects (clicks on autocomplete results) use:

autoselects = client.analytics_autoselects('youtube')

As with searches you can also limit by start and/or end date:

autoselects = client.analytics_autoselects('youtube', 2, 10)

If you are interested in the top queries for your Engine you can use:

top_queries = client.analytics_top_queries('youtube')

To see more top queries you can paginate through them using:

top_queries = client.analytics_top_queries('youtube', page=2)

Or you can get the top queries in a specific date range:

top_queries = client.analytics_top_queries_in_range('youtube', '2013-01-01', '2013-02-01')

If you want to improve you search results, you should always have a look at search queries, that return no results and perhaps add some Documents that match for this query or use our pining feature to add Documents for this query:

top_no_result_queries = client.analytics_top_no_result_queries('youtube')

You can also specify a date range for no result queries:

top_no_result_queries = client.analytics_top_no_result_queries('youtube', '2013-01-01', '2013-02-01')

Platform API

If you've registered your service as a Swiftype Platform Application, you can use this library to create users and take actions on their behalf. (Learn more about the Platform API here.)

First, create a client using your application's client_id and client_secret

platform_client = swiftype.Client(api_key='YOUR_API_KEY', client_id='YOUR_CLIENT_ID', client_secret='YOUR_CLIENT_SECRET')

To retrieve a list of the users for your application (pass optional page and per_page arguments for pagination):

platform_client.users()

To create a user that is managed by your application:

platform_client.create_user()

You can also retrieve users by their ID:

platform_client.user(12345)

To allow your users to access their Swiftype dashboard, route them to their unique SSO URL. This is generated using their user ID (note that this URL expires after 5 minutes, so the URL should be generated at the time the user is requesting access to their dashboard to avoid having to re-generate the URL):

platform_client.sso_url(12345)

You can also create resources on behalf of a user. To do this, you'll need the user's access_token, which is returned when requesting a User resource.

First, create a client with the user's access_token (note that you shouldn't pass an api_key here when creating the client, since you want the requests to take effect on the User's account):

user_client = swiftype.Client(access_token='MY_USERS_ACCESS_TOKEN')

All of the same Engine APIs documented above will work with your new user_client object, but resources will be created on behalf of the User's account rather than your own.