Overview¶

The yige Python SDK makes it easy to use yige.ai

Features¶

• debug console
• text query
• entity manage

Installation¶

To install yige, simply:

$ pip install yige

or install it from repo:

$ pip install https://github.com/wwj718/yige-python.git

Usage¶

1. debug console

>>> yige --console
...

2. send text query

>>> CLIENT_ACCESS_TOKEN = '<YOUR_CLIENT_ACCESS_TOKEN>'
>>> ai = yige.Yige(CLIENT_ACCESS_TOKEN)
>>> request = ai.text_request()
>>> request.query = "我想买鞋"
>>> response = request.getresponse() #注意置信度 confidence
>>> print(response.json())
...

3. post user entities

 >>> DEV_ACCESS_TOKEN = '<YOUR_DEV_ACCESS_TOKEN>'
 >>> ai = yige.Yige(DEV_ACCESS_TOKEN)
 >>> payload= {}
 >>> payload["name"] = "脚型" # 词库名称
 >>> payload["type"] = 1 #是否定义同义词 1是  0否
 >>> payload["automated_expansion"] = 0
 >>> payload["entries"] = [] # 词库内容
 >>> entity1 =  {
             "value": "正常内旋", # 同义词中比较权威的名称
             "synonyms": [ #  同义词
                 "正常内旋",
                 "内旋正常",
                 "正常足弓",
                 "足弓正常"
             ]
         }
 >>> payload["entries"].append(entity1)
 >>> user_entities_request = ai.user_entities_request()
 >>> user_entities_request.user_entities = payload
 >>> user_entities_response = user_entities_request.getresponse()
 >>> print(user_entities_response.json())
...

Running examples¶

1. Find examples from ‘examples’ path.
2. Insert API key.

>>> CLIENT_ACCESS_TOKEN = '<YOUR_CLIENT_ACCESS_TOKEN>'
...

Test¶

make test

Credits¶

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Stable release¶

To install yige, run this command in your terminal:

$ pip install yige

This is the preferred method to install yige, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for yige can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/wwj718/yige

Or download the tarball:

$ curl  -OL https://github.com/wwj718/yige/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up yige for local development.

1. Fork the yige repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/yige.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv yige
   $ cd yige/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 yige tests
   $ python setup.py test or py.test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/wwj718/yige/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ py.test tests.test_yige