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.1.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.1-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for asksageclient-1.2.1.tar.gz
Algorithm Hash digest
SHA256 82bfca324533b14d145d1f0d3ae4cec462be77531bec7caba92fedacde0c8b11
MD5 73ce7015c4dbb393f55c04719c07fe01
BLAKE2b-256 6bf2735f2f469743a16c9fc47d99ef557df25e6590f5cb7e267f9ebb47984bcc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: asksageclient-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.0

File hashes

Hashes for asksageclient-1.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0cb5dc8f8d006ecab79b2504661ec91f44d1aa205a7ae9fa861d793cc1e1f80a
MD5 b1d6c20f48c0dd4216218769e666c85d
BLAKE2b-256 822f21fc062ce1d57bf4412820cc6ffc817c5cb4a7a09fcf2860ea1b5edfc142

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