Skip to main content

An API client for Swiftype Enterprise

Project description

About

A Python client for interacting with Swiftype Enterprise content sources. Documentation for this API client can be found at Readthedocs (http://swiftype-enterprise.readthedocs.io/en/latest/).

For more information, go to our official documentation page (https://app.swiftype.com/ent/docs/custom_sources).

Installation

Swiftype Enterprise Client can be installed with pip:

$ python -m pip install swiftype_enterprise

You can also download the project source and do:

$ python setup.py install

Dependencies

Swiftype Enterprise Client supports Python 2.7 and Python 3.3+. It depends on futures and requests.

Examples

Here’s a basic example for indexing a document into a custom content source. You can get an access token and a content source key after creating a content source here: https://app.swiftype.com/ent/sources/custom/new

from swiftype_enterprise import SwiftypeEnterpriseClient
from swiftype_enterprise.exceptions import SynchronousDocumentIndexingFailed
content_source_key = 'content source key'
authorization_token = 'authorization token'
client = SwiftypeEnterpriseClient(authorization_token)
documents = [
  {
    'external_id': '1234',
    'url': 'https://github.com/swiftype/swiftype-enterprise-python',
    'title': 'Swiftype Enterprise Python Github',
    'body': 'A descriptive body, with document contents and metadata'
  }
]
try:
  document_receipts = client.index_documents(content_source_key, documents, timeout=10, delay=2)
  print(document_receipts)
except SynchronousDocumentIndexingFailed:
  # Timed out before documents could finish indexing
  pass

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for swiftype-enterprise, version 0.0.3
Filename, size File type Python version Upload date Hashes
Filename, size swiftype_enterprise-0.0.3.tar.gz (6.1 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page