clueai 0.0.0.1

A Python library for the ClueAI API

Please go to ClueAI to try examples

Making NLP part of every developer's toolkit.

Clueai Python SDK

This package provides functionality developed to simplify interfacing with the ClueAI API in Python 3.

Installation

The package can be installed with pip:

pip install --upgrade clueai

Install from source:

python setup.py install

Requirements

• Python 3.6+

Quick Start

To use this library, you must have an API key and specify it as a string when creating the clueai.Client object. API keys can be created through the platform. This is a basic example of the creating the client and using the generate endpoint.

Generate

import clueai

# initialize the Clueai Client with an API Key
cl = clueai.Client('YOUR_API_KEY')
prompt= '''
摘要：
本文总结了十个可穿戴产品的设计原则，而这些原则，同样也是笔者认为是这个行业最吸引人的地方：1.为人们解决重复性问题；2.从人开始，而不是从机器开始；3.要引起注意，但不要刻意；4.提升用户能力，而不是取代人
答案：
'''
# generate a prediction for a prompt 
prediction = cl.generate(
            model_name='clueai',
            prompt=prompt)
            
# print the predicted text          
print('prediction: {}'.format(prediction.generations[0].text))

Classify

import clueai
from clueai.classify import Example
# initialize the Clueai Client with an API Key
cl = clueai.Client('YOUR_API_KEY')
response = cl.classify(model_name='clueai',
  task_name='情感分析',
  inputs=["世界充满了欺骗", "世界和平"],
  examples=[Example("基本都是欺骗", "消极"), Example("基本都是惊喜", "积极")],
  labels = ["消极", "积极"])
  
print('prediction: {}'.format(
       response.classifications))

Versioning

To use the SDK with a specific API version, you can specify it when creating the Clueai Client:

import clueai

cl = clueai.Client('YOUR_API_KEY', '2022-08-08')

Endpoints

Clueai Endpoint	Function
/generate	cl.generate()
/classify	cl.classify()

Models

When you call Clueai's APIs we decide on a good default model for your use-case behind the scenes. The default model is great to get you started, but in production environments we recommend that you specify the model size yourself via the model parameter.

Responses

All of the endpoint functions will return a Clueai object corresponding to the endpoint (e.g. for generation, it would be Generation). The responses can be found as instance variables of the object (e.g. generation would be Generation.text). Printing the Clueai response object itself will display an organized view of the instance variables.