Skip to main content

Ask Sage Python Client API

Project description

Ask Sage Python Client

This is the official Python client for the Ask Sage API. It allows you to interact with the Ask Sage service, providing a simple and pythonic way to make requests to the service.

Check Ask Sage API documentation here:

Ask Sage User API: https://app.swaggerhub.com/apis-docs/NICOLASCHAILLAN_1/user-api/1.0

Ask Sage Server API: https://app.swaggerhub.com/apis-docs/NICOLASCHAILLAN_1/server_ask-sage_api/1.0

Installation

You can install the Ask Sage Python client via pip:

pip install asksageclient

Usage

First, import the client:

from asksageclient import AskSageClient

Then, instantiate the client:

client = AskSageClient('your_email_here', 'your_api_key_here') Warning: Do not store credentials in code, use environment variables/secrets instead

Now, you can use the client to interact with the Ask Sage service. For example, to interact with the main endpoint:

response = client.query(message='Who is Nic Chaillan?')

print(response)

Endpoints

The client provides methods for all the Ask Sage API endpoints:

  • add_dataset
  • delete_dataset
  • assign_dataset
  • get_user_logs
  • get_user_logins
  • query
  • query_with_file
  • query_plugin
  • follow_up_questions
  • tokenizer
  • get_personas
  • get_datasets
  • get_plugins
  • count_monthly_tokens
  • count_monthly_teach_tokens
  • train
  • train_with_file
  • file

Each method corresponds to an endpoint of the Ask Sage API. The content parameter should be a dictionary containing the data you want to send in the request body.

Error Handling

The client includes basic error handling. If a request fails, it will print an error message and return None.

Contributing

Contributions are welcome! Please submit a pull request or create an issue to contribute to this project.

License

See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asksageclient-1.2.0.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

asksageclient-1.2.0-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file asksageclient-1.2.0.tar.gz.

File metadata

  • Download URL: asksageclient-1.2.0.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for asksageclient-1.2.0.tar.gz
Algorithm Hash digest
SHA256 80f5523060bec8f1dd8d295f0b72f280ce009be07797527d320282e296e10fb2
MD5 20ed2114801813279ad2aa52c6335f7f
BLAKE2b-256 2c55ffdf8eee86977b8256fa7965dc77f1b80986b63ac8cda05b997ae80ba361

See more details on using hashes here.

File details

Details for the file asksageclient-1.2.0-py3-none-any.whl.

File metadata

  • Download URL: asksageclient-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for asksageclient-1.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e4d5e104e2b874817cc4d12fa7040ab32189a540df657791461c6e4ddf339753
MD5 87d2df192757d893342574456f832562
BLAKE2b-256 072300756cab537513ef9cf7982ec103924ea36b9cb1dfe4397408d29a3203f6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page