Skip to content

bcgov/namex-synonyms-api-py-client

Repository files navigation

img

swagger-client

Retrieves the sets of synonyms for a given word.

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.0
  • 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_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.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

# create an instance of the API class
api_instance = swagger_client.NameProcessingApi(swagger_client.ApiClient(configuration))

try:
    api_instance.get_word_classification()
except ApiException as e:
    print("Exception when calling NameProcessingApi->get_word_classification: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v1

Class Method HTTP request Description
NameProcessingApi get_word_classification GET /name-processing/
ProbesApi get_liveness GET /synonyms/probes/liveness
ProbesApi get_readiness GET /synonyms/probes/readiness
SynonymsApi get_all_any_designations GET /synonyms/all-any-designations
SynonymsApi get_all_categories_synonyms GET /synonyms/all-categories-synonyms
SynonymsApi get_all_end_designations GET /synonyms/all-end-designations
SynonymsApi get_all_substitutions_synonyms GET /synonyms/all-substitutions-synonyms
SynonymsApi get_designated_any_all_words GET /synonyms/designated-any-all-words
SynonymsApi get_designated_end_all_words GET /synonyms/designated-end-all-words
SynonymsApi get_designation_all_in_name GET /synonyms/designation-all-in-name
SynonymsApi get_designation_any_in_name GET /synonyms/designation-any-in-name
SynonymsApi get_designation_end_in_name GET /synonyms/designation-end-in-name
SynonymsApi get_designations GET /synonyms/designations
SynonymsApi get_entity_type_any_designation GET /synonyms/entity-type-any-designation
SynonymsApi get_entity_type_by_value GET /synonyms/entity-type-by-value
SynonymsApi get_entity_type_end_designation GET /synonyms/entity-type-end-designation
SynonymsApi get_exception_regex GET /synonyms/exception-regex
SynonymsApi get_incorrect_designation_end_in_name GET /synonyms/incorrect-designation-end-in-name
SynonymsApi get_misplaced_any_designations GET /synonyms/misplaced-any-designations
SynonymsApi get_misplaced_end_designations GET /synonyms/misplaced-end-designations
SynonymsApi get_number_words GET /synonyms/number-words
SynonymsApi get_prefixes GET /synonyms/prefixes
SynonymsApi get_regex_prefixes GET /synonyms/regex-prefixes
SynonymsApi get_stand_alone GET /synonyms/stand-alone
SynonymsApi get_stop_words GET /synonyms/stop-words
SynonymsApi get_synonyms GET /synonyms/{col}/{term}
SynonymsApi get_transform_text GET /synonyms/transform-text
SynonymsApi get_word_substitutions GET /synonyms/substitutions
SynonymsApi get_word_synonyms GET /synonyms/synonyms

Documentation For Models

Documentation For Authorization

All endpoints do not require authorization.

Author

About

No description or website provided.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •