|
| 1 | +# diffbot-enhance |
| 2 | +Enhance is an API to find a person or organization in the Knowledge Graph using partial data |
| 3 | + |
| 4 | +This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
| 5 | + |
| 6 | +- API version: v3.0.0 |
| 7 | +- Package version: 1.0.0 |
| 8 | +- Build package: org.openapitools.codegen.languages.PythonClientCodegen |
| 9 | + |
| 10 | +## Requirements. |
| 11 | + |
| 12 | +Python 2.7 and 3.4+ |
| 13 | + |
| 14 | +## Installation & Usage |
| 15 | +### pip install |
| 16 | + |
| 17 | +If the python package is hosted on a repository, you can install directly using: |
| 18 | + |
| 19 | +```sh |
| 20 | +pip install git+https://github.com/GIT_USER_ID/enhance-java-client.git |
| 21 | +``` |
| 22 | +(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/enhance-java-client.git`) |
| 23 | + |
| 24 | +Then import the package: |
| 25 | +```python |
| 26 | +import diffbot_enhance |
| 27 | +``` |
| 28 | + |
| 29 | +### Setuptools |
| 30 | + |
| 31 | +Install via [Setuptools](http://pypi.python.org/pypi/setuptools). |
| 32 | + |
| 33 | +```sh |
| 34 | +python setup.py install --user |
| 35 | +``` |
| 36 | +(or `sudo python setup.py install` to install the package for all users) |
| 37 | + |
| 38 | +Then import the package: |
| 39 | +```python |
| 40 | +import diffbot_enhance |
| 41 | +``` |
| 42 | + |
| 43 | +## Getting Started |
| 44 | + |
| 45 | +Please follow the [installation procedure](#installation--usage) and then run the following: |
| 46 | + |
| 47 | +```python |
| 48 | +from __future__ import print_function |
| 49 | +import time |
| 50 | +import diffbot_enhance |
| 51 | +from diffbot_enhance.rest import ApiException |
| 52 | +from pprint import pprint |
| 53 | + |
| 54 | + |
| 55 | +# Defining host is optional and default to https://kg.diffbot.com |
| 56 | +configuration.host = "https://kg.diffbot.com" |
| 57 | +# Create an instance of the API class |
| 58 | +api_instance = diffbot_enhance.BulkEnhanceEndpointApi(diffbot_enhance.ApiClient(configuration)) |
| 59 | +bulkjob_id = 'bulkjob_id_example' # str | Bulkjob Id |
| 60 | +token = 'token_example' # str | Diffbot Token (optional) |
| 61 | + |
| 62 | +try: |
| 63 | + # Bulk Enhance Status Endpoint |
| 64 | + api_response = api_instance.bulkjob_status(bulkjob_id, token=token) |
| 65 | + pprint(api_response) |
| 66 | +except ApiException as e: |
| 67 | + print("Exception when calling BulkEnhanceEndpointApi->bulkjob_status: %s\n" % e) |
| 68 | + |
| 69 | +``` |
| 70 | + |
| 71 | +## Documentation for API Endpoints |
| 72 | + |
| 73 | +All URIs are relative to *https://kg.diffbot.com* |
| 74 | + |
| 75 | +Class | Method | HTTP request | Description |
| 76 | +------------ | ------------- | ------------- | ------------- |
| 77 | +*BulkEnhanceEndpointApi* | [**bulkjob_status**](docs/BulkEnhanceEndpointApi.md#bulkjob_status) | **GET** /kg/enhance_endpoint/bulk/{bulkjobId}/status | Bulk Enhance Status Endpoint |
| 78 | +*BulkEnhanceEndpointApi* | [**enhance_bulkjob**](docs/BulkEnhanceEndpointApi.md#enhance_bulkjob) | **POST** /kg/enhance_endpoint/bulk | Bulk Enhance Endpoint |
| 79 | +*BulkEnhanceEndpointApi* | [**poll_bulkjob**](docs/BulkEnhanceEndpointApi.md#poll_bulkjob) | **GET** /kg/enhance_endpoint/bulk/{bulkjobId} | Bulk Enhance Poll Endpoint |
| 80 | +*BulkEnhanceEndpointApi* | [**stop_bulkjob**](docs/BulkEnhanceEndpointApi.md#stop_bulkjob) | **GET** /kg/enhance_endpoint/bulk/{bulkjobId}/stop | Bulkjob stop |
| 81 | +*EnhanceLiveEndpointApi* | [**enhance**](docs/EnhanceLiveEndpointApi.md#enhance) | **GET** /kg/enhance_endpoint | Live Enhance Endpoint |
| 82 | + |
| 83 | + |
| 84 | +## Documentation For Models |
| 85 | + |
| 86 | + - [BulkjobAccepted](docs/BulkjobAccepted.md) |
| 87 | + - [BulkjobRecoveryStatusResponse](docs/BulkjobRecoveryStatusResponse.md) |
| 88 | + - [BulkjobStatus](docs/BulkjobStatus.md) |
| 89 | + - [BulkjobStatusResponse](docs/BulkjobStatusResponse.md) |
| 90 | + - [EnhanceResponse](docs/EnhanceResponse.md) |
| 91 | + - [RequestError](docs/RequestError.md) |
| 92 | + |
| 93 | + |
| 94 | +## Documentation For Authorization |
| 95 | + |
| 96 | + All endpoints do not require authorization. |
| 97 | + |
| 98 | +## Author |
| 99 | + |
| 100 | + |
| 101 | + |
| 102 | + |
0 commit comments