Skip to main content

No project description provided

Project description

Logo Logo

Cursive is a universal and intuitive framework for interacting with LLMs.

highlights

Extensible - You can easily hook into any part of a completion life cycle. Be it to log, cache, or modify the results.

Functions - Easily describe functions that the LLM can use along with its definition, with any model (currently supporting GPT-4, GPT-3.5, Claude 2, and Claude Instant)

Universal - Cursive aims to bridge as many capabilities between different models as possible. Ultimately, this means that with a single interface, you can allow your users to choose any model.

Informative - Cursive comes with built-in token usage and costs calculations, as accurate as possible.

Reliable - Cursive comes with automatic retry and model expanding upon exceeding context length. Which you can always configure.

quickstart

  1. Install.
poetry add cursivepy
# or
pip install cursivepy
  1. Start using.
from cursive import Cursive

cursive = Cursive()

response = cursive.ask(
    prompt='What is the meaning of life?',
)

print(response.answer)

usage

Conversation

Chaining a conversation is easy with cursive. You can pass any of the options you're used to with OpenAI's API.

res_a = cursive.ask(
    prompt='Give me a good name for a gecko.',
    model='gpt-4',
    max_tokens=16,
)

print(res_a.answer) # Zephyr

res_b = res_a.conversation.ask(
    prompt='How would you say it in Portuguese?'
)

print(res_b.answer) # Zéfiro

Streaming

Streaming is also supported, and we also keep track of the tokens for you!

result = cursive.ask(
    prompt='Count to 10',
    stream=True,
    on_token=lambda partial: print(partial['content'])
)

print(result.usage.total_tokens) # 40

Functions

You can use very easily to define and describe functions, along side with their execution code.

from cursive import cursive_function, Cursive

cursive = Cursive()

@cursive_function()
def add(a: float, b: float):
    """
    Adds two numbers.

    a: The first number.
    b: The second number.
    """
    return a + b

res = cursive.ask(
    prompt='What is the sum of 232 and 243?',
    functions=[add],
)

print(res.answer) # The sum of 232 and 243 is 475.

The functions' result will automatically be fed into the conversation and another completion will be made. If you want to prevent this, you can add pause to your function definition.

@cursive_function(pause=True)
def create_character(name: str, age: str):
    """
    Creates a character.

    name: The name of the character.
    age: The age of the character.
    """
    return {
        'name': name,
        'age': age,
    }

res = cursive.ask(
    prompt='Create a character named John who is 23 years old.',
    functions=[create_character],
)

print(res.function_result) # { name: 'John', age: 23 }

Hooks

You can hook into any part of the completion life cycle.

cursive.on('completion:after', lambda result: print(
    result.data.cost.total,
    result.data.usage.total_tokens,
))

cursive.on('completion:error', lambda result: print(
    result.error,
))

cursive.ask({
    prompt: 'Can androids dream of electric sheep?',
})

# 0.0002185
# 113

Embedding

You can create embeddings pretty easily with cursive.

embedding = cursive.embed('This should be a document.')

This will support different types of documents and integrations pretty soon.

Reliability

Cursive comes with automatic retry with backoff upon failing completions, and model expanding upon exceeding context length -- which means that it tries again with a model with a bigger context length when it fails by running out of it.

You can configure this behavior by passing the retry and expand options to Cursive constructor.

cursive = Cursive(
    max_retries=5, # 0 disables it completely
    expand={
        'enable': True,
        'defaults_to': 'gpt-3.5-turbo-16k',
        'resolve_model': {
            'gpt-3.5-turbo': 'gpt-3.5-turbo-16k',
            'gpt-4': 'claude-2',
        },
    },
)

available models

OpenAI

  • gpt-3.5-turbo
  • gpt-3.5-turbo-16k
  • gpt-4
  • gpt-4-32k
  • Any other chat completion model version
Credentials

You can pass your OpenAI API key to Cursive's constructor, or set the OPENAI_API_KEY environment variable.

Anthropic

  • claude-2
  • claude-instant-1
  • claude-instant-1.2
  • Any other model version
Credentials

You can pass your Anthropic API key to Cursive's constructor, or set the ANTHROPIC_API_KEY environment variable.

OpenRouter

OpenRouter is a service that gives you access to leading language models in an OpenAI-compatible API, including function calling!

  • anthropic/claude-instant-1.2
  • anthropic/claude-2
  • openai/gpt-4-32k
  • google/palm-2-codechat-bison
  • nousresearch/nous-hermes-llama2-13b
  • Any model version from https://openrouter.ai/docs#models
Credentials
from cursive import Cursive

cursive = Cursive(
    openrouter={
      "api_key": "sk-or-...",
      "app_title": "Your App Name",
      "app_url": "https://appurl.com",
    }
)

cursive.ask(
    model="anthropic/claude-instant-1.2",
    prompt="What is the meaning of life?"
)

Cohere

  • command
  • Any other model version (such as command-nightly)
Credentials

You can pass your Cohere API key to Cursive's constructor, or set the COHERE_API_KEY environment variable.

Replicate

You can prepend replicate/ to any model name and version available on Replicate.

Example
cursive.ask(
    prompt='What is the meaning of life?',
    model='replicate/a16z-infra/llama-2-13b-chat:2a7f981751ec7fdf87b5b91ad4db53683a98082e9ff7bfd12c8cd5ea85980a52',
)
Credentials

You can pass your Replicate API key to Cursive's constructor, or set the REPLICATE_API_TOKEN environment variable.

roadmap

vendor support

  • Anthropic
  • Cohere
  • Replicate
  • Azure OpenAI models
  • Huggingface

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

cursivepy-0.6.1.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

cursivepy-0.6.1-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

Details for the file cursivepy-0.6.1.tar.gz.

File metadata

  • Download URL: cursivepy-0.6.1.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Darwin/22.5.0

File hashes

Hashes for cursivepy-0.6.1.tar.gz
Algorithm Hash digest
SHA256 328e9a2e8c59a89b28bac999c7b49eb0191ec05bf0ccb17eedadf199bf7b480d
MD5 cb9637b31aca22bfd87623e5823bb727
BLAKE2b-256 9fd1b67fb7c901e2b2c766f4714e1cdf41f6ede3d15ddee00eaaa74b137181b2

See more details on using hashes here.

File details

Details for the file cursivepy-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: cursivepy-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 25.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Darwin/22.5.0

File hashes

Hashes for cursivepy-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 19ebafa4adb945b236492681fb81015de03eb116d00739c88d73f1a738abc605
MD5 79cd0cded5946e7c0c1e70041226e280
BLAKE2b-256 00e1e843e5a829a695aa44c06b6b9dc118efe738c6397db40327517d09e5bc5e

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