Skip to content

Commit 0a1814c

Browse files
no message
0 parents  commit 0a1814c

38 files changed

+4295
-0
lines changed

README.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
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+

diffbot_enhance/__init__.py

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# coding: utf-8
2+
3+
# flake8: noqa
4+
5+
"""
6+
Diffbot Enhance Service
7+
8+
Enhance is an API to find a person or organization in the Knowledge Graph using partial data # noqa: E501
9+
10+
The version of the OpenAPI document: v3.0.0
11+
12+
Generated by: https://openapi-generator.tech
13+
"""
14+
15+
16+
from __future__ import absolute_import
17+
18+
__version__ = "1.0.0"
19+
20+
# import apis into sdk package
21+
from diffbot_enhance.api.bulk_enhance_endpoint_api import BulkEnhanceEndpointApi
22+
from diffbot_enhance.api.enhance_live_endpoint_api import EnhanceLiveEndpointApi
23+
24+
# import ApiClient
25+
from diffbot_enhance.api_client import ApiClient
26+
from diffbot_enhance.configuration import Configuration
27+
from diffbot_enhance.exceptions import OpenApiException
28+
from diffbot_enhance.exceptions import ApiTypeError
29+
from diffbot_enhance.exceptions import ApiValueError
30+
from diffbot_enhance.exceptions import ApiKeyError
31+
from diffbot_enhance.exceptions import ApiException
32+
# import models into sdk package
33+
from diffbot_enhance.models.bulkjob_accepted import BulkjobAccepted
34+
from diffbot_enhance.models.bulkjob_recovery_status_response import BulkjobRecoveryStatusResponse
35+
from diffbot_enhance.models.bulkjob_status import BulkjobStatus
36+
from diffbot_enhance.models.bulkjob_status_response import BulkjobStatusResponse
37+
from diffbot_enhance.models.enhance_response import EnhanceResponse
38+
from diffbot_enhance.models.request_error import RequestError
39+

diffbot_enhance/api/__init__.py

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
from __future__ import absolute_import
2+
3+
# flake8: noqa
4+
5+
# import apis into api package
6+
from diffbot_enhance.api.bulk_enhance_endpoint_api import BulkEnhanceEndpointApi
7+
from diffbot_enhance.api.enhance_live_endpoint_api import EnhanceLiveEndpointApi

0 commit comments

Comments
 (0)