Skip to main content

Athena Intelligence Python Library

Project description

Athena Intelligence Python Library

fern shield pypi

The Athena Intelligence Python Library provides convenient access to the Athena Intelligence API from applications written in Python.

The library includes type definitions for all request and response fields, and offers both synchronous and asynchronous clients powered by httpx.

Installation

Add this dependency to your project's build file:

pip install athena-intelligence
# or
poetry add athena-intelligence

Usage

Simply import Athena and start making calls to our API.

from athena.client import Athena
from athena import Model, Tools

client = Athena(
  api_key="YOUR_API_KEY" # Defaults to ATHENA_API_KEY
)
message = client.message.submit(
    content="visit www.athenaintelligence.ai and summarize the website in one paragraph",
    model=Model.GPT_3_5_TURBO,
    tools=[Tools.SEARCH, Tools.BROWSE, Tools.SEARCH],
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API.

from athena.client import AsyncAthena
from athena import Model, Tools

client = AsyncAthena(
  api_key="YOUR_API_KEY" # Defaults to ATHENA_API_KEY
)

async def main() -> None:
    message = client.message.submit(
      content="visit www.athenaintelligence.ai and summarize the website in one paragraph",
      model=Model.GPT_3_5_TURBO,
      tools=[Tools.SEARCH, Tools.BROWSE, Tools.SEARCH],
    )
    print("Received message", message)

asyncio.run(main())

Polling

The SDK provides helper functions that will automatically poll when retrieving a message. Use the submit_and_poll method as shown below:

from athena.client import Athena
from athena import Model, Tools

client = Athena(api_key="...")
message =  client.message.submit_and_poll(
  content="visit www.athenaintelligence.ai and summarize the website in one paragraph",
  model=Model.GPT_3_5_TURBO,
  tools=[Tools.SEARCH, Tools.BROWSE, Tools.SEARCH],
)

By default, the method will poll every 2 seconds but you can override this with the poll_interval argument.

Athena Module

All of the models are nested within the Athena module. Let IntelliSense guide you!

Exception Handling

All errors thrown by the SDK will be subclasses of ApiError.

import athena

try:
  client.messages.get(...)
except athena.core.ApiError as e: # Handle all errors
  print(e.status_code)
  print(e.body)

Advanced

Timeouts

By default, requests time out after 60 seconds. You can configure this with a timeout option at the client or request level.

from athena.client import Athena

client = Athena(
    # All timeouts are 20 seconds
    timeout=20.0,
)

# Override timeout for a specific method
client.messages.get(..., {
    timeout_in_seconds=20
})

Custom HTTP client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx

from athena.client import Athena

client = Athena(
    http_client=httpx.Client(
        proxies="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Beta Status

This SDK is in Preview, and there may be breaking changes between versions without a major version update.

To ensure a reproducible environment (and minimize risk of breaking changes), we recommend pinning a specific package version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

athena_intelligence-0.1.911.tar.gz (78.3 kB view details)

Uploaded Source

Built Distribution

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

athena_intelligence-0.1.911-py3-none-any.whl (157.0 kB view details)

Uploaded Python 3

File details

Details for the file athena_intelligence-0.1.911.tar.gz.

File metadata

  • Download URL: athena_intelligence-0.1.911.tar.gz
  • Upload date:
  • Size: 78.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.9.25 Linux/6.14.0-1017-azure

File hashes

Hashes for athena_intelligence-0.1.911.tar.gz
Algorithm Hash digest
SHA256 b76931b555b8ccfcfba465aecf87d3725541c17ea0b78c0ab3827bd1ff567d51
MD5 2f7b4d876fcb50200e0c344487eea5ce
BLAKE2b-256 a55d2be9a495dca871e50b22d1a5ad888e6f1655dfceae859da59703af049627

See more details on using hashes here.

File details

Details for the file athena_intelligence-0.1.911-py3-none-any.whl.

File metadata

  • Download URL: athena_intelligence-0.1.911-py3-none-any.whl
  • Upload date:
  • Size: 157.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.9.25 Linux/6.14.0-1017-azure

File hashes

Hashes for athena_intelligence-0.1.911-py3-none-any.whl
Algorithm Hash digest
SHA256 e061dc6eb86129a5d2326b8da1676066ec23694422c7ffcb716d83bf82a6e02f
MD5 462ed4c0570ac18be67f241cbc2763eb
BLAKE2b-256 885cbc84613217265e5a5378fa8becb9b150b79cf965d616b597376d2208bec1

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