Skip to main content

Keywords AI SDK allows you to interact with the Keywords AI API smoothly

Project description

Keywords AI SDK

Keywords AI Python SDK allows you to easily interact with the Keywords AI API.

Get started

Get started with Keywords AI in minutes

Installation

Users

Poetry

poetry add keywordsai

Pip

pip install keywordsai

Developers and Contributers

You can install the current directory as a python package via this command

poetry install

or

pip install . -e

Environment Variables

touch .env

Inside the .env file, you can configure the constants througout the library

DEBUG # Default is "False", set to "True" to enable debug mode for more verbose output
KEYWORDSAI_BASE_URL # Default is "https://api.keywordsai.co/api/", the slash at the end is important
KEYWORDSAI_API_KEY # Your Keywords AI API Key

Change values during runtime (not recommended)

import keywordsai.keywordsai_config as config
config.KEYWORDSAI_BASE_URL = "some_url"

Usage

Proxy

With Keywords AI as a proxy, observability comes out of box.

from openai import OpenAI
import os
client = OpenAI(
    api_key=os.getenv("KEYWORDSAI_API_KEY"),
    base_url=os.getenv("KEYWORDSAI_BASE_URL")
)

# Use the client to make requests as you would with the OpenAI SDK

Wrapper (Beta)

Wrap around the OpenAI completion function to automatically log the request and response

Synchronous:

from keywordsai import KeywordsAI
from openai import OpenAI
client = OpenAI()
def test_generation():
    kai = KeywordsAI()
    try:
        wrapped_creation = kai.logging_wrapper(client.chat.completions.create)
        response = wrapped_creation(
            model=test_model,
            messages=test_messages,
            stream=False,
            extra_body={"mock_response": test_mock_response},
        )
        assert isinstance(response, ChatCompletion)
    except Exception as e:
        assert False, e


if __name__ == "__main__":
    generator = test_generation()

Asynchronous:

from tests.test_env import *
from keywordsai.core import KeywordsAI, AsyncGenerator
from openai import AsyncOpenAI
from openai.types.chat.chat_completion import ChatCompletion

client = AsyncOpenAI()

async def test_stream_generation():
    kai = KeywordsAI()
    try:
        wrapped_creation = kai.async_logging_wrapper(client.chat.completions.create)
        # wrapped_creation = oai_client.chat.completions.create
        response = await wrapped_creation(
            model=test_model,
            messages=test_messages,
            stream=True,
        )
        assert isinstance(response, AsyncGenerator)
        return response
    except Exception as e:
        print(e)

async def test_generation():
    kai = KeywordsAI()
    try:
        wrapped_creation = kai.async_logging_wrapper(client.chat.completions.create, keywordsai_params={
            "customer_identifier": "sdk_customer",
        })
        response = await wrapped_creation(
            model=test_model,
            messages=test_messages,
            stream=False,

        )
        assert isinstance(response, ChatCompletion)
        return response
    except Exception as e:
        assert False, e

import asyncio

async def run_stream():
    response = await test_stream_generation()
    async for chunk in response:
        content = chunk.choices[0].delta.content
        if content:
            print(content, end="")
        pass

if __name__ == "__main__":
    # non streaming
    asyncio.run(test_generation())

    # streaming
    asyncio.run(run_stream())
    KeywordsAI.flush()


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

keywordsai-0.1.5.tar.gz (38.8 kB view details)

Uploaded Source

Built Distribution

keywordsai-0.1.5-py3-none-any.whl (17.0 kB view details)

Uploaded Python 3

File details

Details for the file keywordsai-0.1.5.tar.gz.

File metadata

  • Download URL: keywordsai-0.1.5.tar.gz
  • Upload date:
  • Size: 38.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Darwin/23.5.0

File hashes

Hashes for keywordsai-0.1.5.tar.gz
Algorithm Hash digest
SHA256 46c56f755e391ac6aa97cdb8c80dde92677bdc96ff4fa40013cc63ffa7d2bdac
MD5 426bfc9e77770cc14365c99f78b358e6
BLAKE2b-256 1c2756270b123ac59bb40cd0617dbcb6735e6b0d1c1aa851ca455144ef600654

See more details on using hashes here.

File details

Details for the file keywordsai-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: keywordsai-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 17.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Darwin/23.5.0

File hashes

Hashes for keywordsai-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 23109966165ee1292c3e2ed770ce907fb0868333248e8f5422fb103de37136e5
MD5 7f826abbc9ee6bc18ec150404a3d4d3e
BLAKE2b-256 eb47a0916a2a84e54e243ddbff1aeea9a819122db72d2f1778b03ab665eec727

See more details on using hashes here.

Supported by

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