Code Monkey home page Code Monkey logo

vellum-client-ruby's Introduction

Vellum Ruby Library

fern shield

The Vellum Ruby Library provides access to the Vellum API from Ruby.

API Docs

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

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add vellum_ai

If bundler is not being used to manage dependencies, install the gem by executing:

gem install vellum_ai

Usage

require "vellum_ai"


client = Vellum::Client.new(api_key: ENV['VELLUM_API_KEY'])

result = client.execute_prompt(
    prompt_deployment_name: "my-deployment",
    inputs: [
        {
            "type": "STRING",
            "name": "question",
            "value": "Can I get a refund?"
        }
    ],
)

puts result.outputs[0].value

Async Client

require "vellum_ai"


client = Vellum::AsyncClient.new(api_key: ENV['VELLUM_API_KEY'])

result = client.execute_prompt(
    prompt_deployment_name: "my-deployment",
    inputs: [
        {
            "type": "STRING",
            "name": "question",
            "value": "Can I get a refund?"
        }
    ],
)

puts result.wait.outputs[0].value

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. Not that the SDK allows you to pass in a path to the file, or a File object.

require "vellum_ai"


client = Vellum::Client.new(api_key: ENV['VELLUM_API_KEY'])
result = client.documents.upload(
    # File to upload
    contents: "/path/to/your/file.txt",
    # 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: [],
)

puts 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!

vellum-client-ruby's People

Contributors

armandobelardo avatar dvargas92495 avatar fern-api[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.