swagger-client
This API provides AI search functionalities: summary search and department recommendation. Use the following code to authorize: nTsVPfUb89Ize/1DVSx2xKjLltOagND80lEfHaVB3fGT8CQEF7e9Lw==
This Python package is automatically generated by the Swagger Codegen project:
- API version: 1.0.2
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.PythonClientCodegen
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
pip install git+https://github.com//.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com//.git
)
Then import the package:
import swagger_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import swagger_client
Getting Started
Please follow the installation procedure and then run the following:
from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: apikeyQuery
swagger_client.configuration.api_key['code'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['code'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.AISearchApi()
search = 'search_example' # str | Looking for existing summaries or departments that relate to the search string
organization = 'organization_example' # str | Filter results to the specified organization. (optional)
year = 56 # int | Filter results to the specified year. (optional)
month = 56 # int | Filter results to the specified month. (optional)
items_per_page = 10 # int | Determines how many items to include in one page. (optional) (default to 10)
page = 1 # int | Indicates which result page to display. (optional) (default to 1)
try:
# Summary search
api_response = api_instance.api_get_combined_requestsget(search, organization=organization, year=year, month=month, items_per_page=items_per_page, page=page)
pprint(api_response)
except ApiException as e:
print("Exception when calling AISearchApi->api_get_combined_requestsget: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://atip-dev-2-searchapi.azurewebsites.net
Class | Method | HTTP request | Description |
---|---|---|---|
AISearchApi | api_get_combined_requestsget | GET /api/GetCombinedRequests | Summary search |
AISearchApi | api_get_departmentsget | GET /api/GetDepartments | Department recommendation |
AISearchApi | api_get_summariesget | GET /api/GetSummaries | Summary search |
Documentation For Models
- CombinedResult
- DepartmentRecommendation
- DepartmentRecommendationResult
- SummaryDocument
- SummarySearchResult
- SummarySearchResultResponse
- SummarySearchResultResponseHeader
- SummarySearchResultResponseHeaderParams
Documentation For Authorization
apikeyQuery
- Type: API key
- API key parameter name: code
- Location: URL query string