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"
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:

import sys
sys.path.append(".")
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


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

keywordsai_sdk-0.2.73.tar.gz (80.3 kB view details)

Uploaded Source

Built Distribution

keywordsai_sdk-0.2.73-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

Details for the file keywordsai_sdk-0.2.73.tar.gz.

File metadata

  • Download URL: keywordsai_sdk-0.2.73.tar.gz
  • Upload date:
  • Size: 80.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Darwin/24.1.0

File hashes

Hashes for keywordsai_sdk-0.2.73.tar.gz
Algorithm Hash digest
SHA256 ea09b7fb4ffc2054c3295fae37cb4aa3d1490bc0f57e3501ffa212268eed1ada
MD5 cce9b7c92730bcb4b37734f0d7ff6243
BLAKE2b-256 f5f1ae794515020298c457e5e19f8469d7781e3e21f0d8e38bf260bb3639027c

See more details on using hashes here.

File details

Details for the file keywordsai_sdk-0.2.73-py3-none-any.whl.

File metadata

  • Download URL: keywordsai_sdk-0.2.73-py3-none-any.whl
  • Upload date:
  • Size: 38.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.4 Darwin/24.1.0

File hashes

Hashes for keywordsai_sdk-0.2.73-py3-none-any.whl
Algorithm Hash digest
SHA256 60de7d38a8c5f063a810b532872c42e96268c017e3285a45d6bc39e2645d9444
MD5 df492874404dfb804db28484abd82526
BLAKE2b-256 c4c6a6d76196b7f858d0823e3f3b7fdcec83e53be2092c59451d77787aabffbf

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