Skip to main content

No project description provided

Project description

Vellum Python Library

pypi fern shield

The Vellum Python Library 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

import vellum
from vellum.client import Vellum


client = Vellum(api_key="YOUR_API_KEY")

result = client.generate(
    deployment_name="my-deployment",
    requests=[
        vellum.GenerateRequest(
            input_values={"question": "Can I get a refund?"})]
    )

print(result.text)

Async Client

import vellum
from vellum.client import AsyncVellum

raven = AsyncVellum(api_key="YOUR_API_KEY")

async def generate() -> str:
  result = client.generate(
    deployment_name="my-deployment",
    requests=[
        vellum.GenerateRequest(
            input_values={"question": "Can I get a refund?"})]
    )
  
  return result.text

Uploading documents

Documents can be uploaded to Vellum via either the UI or this API. Once uploaded and indexed, Vellum's Search allows you to perform semantic searches against them.

from vellum.client import Vellum

client = Vellum(api_key="YOUR_API_KEY")

with open("/path/to/your/file.txt", "rb") as file:
    result = client.documents.upload(
        # File to upload
        contents=file,
        # Document label
        label="Human-friendly label for your document",
        # The names of indexes that you'd like this document to be added to.
        add_to_index_names=["<your-index-name>"],
        # Optionally include a unique ID from your system to this document later.
        #   Useful if you want to perform updates later
        external_id="<your-index-name>",
        # Optionally include keywords to associate with the document that can be used in hybrid search
        keywords=[],
    )

print(result)

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your pyproject.toml file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest 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

vellum_ai-0.0.19.tar.gz (28.1 kB view details)

Uploaded Source

Built Distribution

vellum_ai-0.0.19-py3-none-any.whl (91.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vellum_ai-0.0.19.tar.gz
  • Upload date:
  • Size: 28.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.7.17 Linux/5.15.0-1041-azure

File hashes

Hashes for vellum_ai-0.0.19.tar.gz
Algorithm Hash digest
SHA256 79263bab688b2116a92c5bc419d83b343a12bc2689f005021acfcdcb70030518
MD5 744f94ee35c15807e00be0a7f7b16955
BLAKE2b-256 93ba417e31a5feb50fb124663752ed4a58ff6e8e5754143434f70d4fb6d6366c

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for vellum_ai-0.0.19-py3-none-any.whl
Algorithm Hash digest
SHA256 73c355dddafa6d8c0d80870279246a76fed261cd9c4ea2086dae5bddab7219a9
MD5 a975522379b88a864b85b5593f9f54f5
BLAKE2b-256 b36184af2f9e737328e0f66fee6dc58c3d69a14edd9f8dff56cf7dfaabe99def

See more details on using hashes here.

Provenance

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