Skip to main content

No project description provided

Project description

Vellum Python Library

pypi license badge fern shield

The Vellum Python SDK provides access to the Vellum API from python.

API Docs

You can find Vellum's complete API docs at docs.vellum.ai.

Installation

pip install --upgrade vellum-ai

Usage

Below is how you would invoke a deployed Prompt from the Vellum API. For a complete list of all APIs that Vellum supports, check out our API Reference.

from vellum import (
    StringInputRequest,
)
from vellum.client import Vellum

client = Vellum(
    api_key="YOUR_API_KEY",
)

def execute() -> str:
    result = client.execute_prompt(
        prompt_deployment_name="<example-deployment-name>>",
        release_tag="LATEST",
        inputs=[
            StringInputRequest(
                name="input_a",
                type="STRING",
                value="Hello, world!",
            )
        ],
    )
    
    if result.state == "REJECTED":
        raise Exception(result.error.message)

    return result.outputs[0].value

if __name__ == "__main__":
    print(execute())

[!TIP] You can set a system environment variable VELLUM_API_KEY to avoid writing your api key within your code. To do so, add export VELLUM_API_KEY=<your-api-token> to your ~/.zshrc or ~/.bashrc, open a new terminal, and then any code calling vellum.Vellum() will read this key.

Async Client

This SDK has an async version. Here's how to use it:

import asyncio

import vellum
from vellum.client import AsyncVellum

client = AsyncVellum(api_key="YOUR_API_KEY")

async def execute() -> str:
    result = await client.execute_prompt(
        prompt_deployment_name="<example-deployment-name>>",
        release_tag="LATEST",
        inputs=[
            vellum.StringInputRequest(
                name="input_a",
                value="Hello, world!",
            )
        ],
    )

    if result.state == "REJECTED":
        raise Exception(result.error.message)
    
    return result.outputs[0].value

if __name__ == "__main__":
    print(asyncio.run(execute()))

Contributing

While we value open-source contributions to this SDK, most of this library is generated programmatically.

Please feel free to make contributions to any of the directories or files below:

examples/*
src/vellum/lib/*
tests/*
README.md

Any additions made to files beyond those directories and files above would have to be moved over to our generation code (found in the separate vellum-client-generator repo), 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!

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

vellum_ai-0.9.14.tar.gz (155.7 kB view details)

Uploaded Source

Built Distribution

vellum_ai-0.9.14-py3-none-any.whl (428.8 kB view details)

Uploaded Python 3

File details

Details for the file vellum_ai-0.9.14.tar.gz.

File metadata

  • Download URL: vellum_ai-0.9.14.tar.gz
  • Upload date:
  • Size: 155.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1074-azure

File hashes

Hashes for vellum_ai-0.9.14.tar.gz
Algorithm Hash digest
SHA256 a2c0555026ca7be08561e48a2af12c68f4f321d903515e19a8adc8f9f795eeb7
MD5 390ee47b17a61e9f858902d0f221f90b
BLAKE2b-256 f3b02c2b4b98eab13f3d980c42b2ef7ca057285c01c9382a71cec44eca030886

See more details on using hashes here.

File details

Details for the file vellum_ai-0.9.14-py3-none-any.whl.

File metadata

  • Download URL: vellum_ai-0.9.14-py3-none-any.whl
  • Upload date:
  • Size: 428.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/5.15.0-1074-azure

File hashes

Hashes for vellum_ai-0.9.14-py3-none-any.whl
Algorithm Hash digest
SHA256 2654a2a25a92fbedb59995565a1d54d79fbb1787e2d872a034b5d6daced25bd0
MD5 0212c9294ee5af4d44e80700c5e8639c
BLAKE2b-256 be434e921d1f78a85fe8a67df25f5c5a9ce72aee49e6ea44efc733a7c36cf3f9

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