Categorygithub.com/vellum-ai/vellum-client-go
modulepackage
0.9.9
Repository: https://github.com/vellum-ai/vellum-client-go.git
Documentation: pkg.go.dev

# README

Vellum Go Library

fern shield license badge go shield

The Vellum Go library provides convenient access to the Vellum API from Go.

Requirements

This module requires Go version >= 1.18.

Installation

Run the following command to use the Vellum Go library in your module:

go get github.com/vellum-ai/vellum-client-go

Usage

import vellumclient "github.com/vellum-ai/vellum-client-go/client"

client := vellumclient.NewClient(vellumclient.WithApiKey("<YOUR_AUTH_TOKEN>"))

Generate Completion

import (
  vellum       "github.com/vellum-ai/vellum-client-go"
  vellumclient "github.com/vellum-ai/vellum-client-go/client"
)

client := vellumclient.NewClient(vellumclient.WithApiKey("<YOUR_AUTH_TOKEN>"))
response, err := client.ExecutePrompt(
  context.TODO(),
  &vellum.ExecutePromptRequest{
    PromptDeploymentName: vellum.String("<your-deployment-name>"),
    Inputs: []*vellum.PromptDeploymentInputRequest{
      {
        Type: "String",
        String: &vellum.StringInputRequest{
          Name:  "<input_a>",
          Value: "Hello, world!",
        },
      },
    },
  },
)

Timeouts

Setting a timeout for each individual request is as simple as using the standard context library. Setting a one second timeout for an individual API call looks like the following:

ctx, cancel := context.WithTimeout(context.TODO(), time.Second)
defer cancel()

response, err := client.ExecutePrompt(
  ctx,
  &vellum.ExecutePromptRequest{
    PromptDeploymentName: vellum.String("<your-deployment-name>"),
    Inputs: []*vellum.PromptDeploymentInputRequest{
      {
        Type: "String",
        String: &vellum.StringInputRequest{
          Name:  "<input_a>",
          Value: "Hello, world!",
        },
      },
    },
  },
)

Client Options

A variety of client options are included to adapt the behavior of the library, which includes configuring authorization tokens to be sent on every request, or providing your own instrumented *http.Client. Both of these options are shown below:

client := vellumclient.NewClient(
  vellumclient.WithApiKey("<YOUR_AUTH_TOKEN>"),
  vellumclient.WithHTTPClient(
    &http.Client{
      Timeout: 5 * time.Second,
    },
  ),
)

Providing your own *http.Client is recommended. Otherwise, the http.DefaultClient will be used, and your client will wait indefinitely for a response (unless the per-request, context-based timeout is used).

Errors

Structured error types are returned from API calls that return non-success status codes. For example, you can check if the error was due to a bad request (i.e. status code 400) with the following:

response, err := client.ExecutePrompt(
  ctx,
  &vellum.ExecutePromptRequest{
    PromptDeploymentName: vellum.String("<invalid-name>"), // Updated to use an invalid deployment name
    Inputs: []*vellum.PromptDeploymentInputRequest{
      {
        Type: "String",
        String: &vellum.StringInputRequest{
          Name:  "<input_a>",
          Value: "Hello, world!",
        },
      },
    },
  },
)
if err != nil {
  if badRequestErr, ok := err.(*vellum.BadRequestError); ok {
    // Do something with the bad request error
    // Handle the bad request error specifically
  }
  return err // Ensure to return the error if present
}

These errors are also compatible with the errors.Is and errors.As APIs, so you can access the error like so:

response, err := client.Generate(
  ctx,
  &vellum.ExecutePromptRequest{
    PromptDeploymentName: vellum.String("<invalid-name>"), // Updated to use an invalid deployment name
    Inputs: []*vellum.PromptDeploymentInputRequest{


      {
        Type: "String",
        String: &vellum.StringInputRequest{
          Name:  "<input_a>",
          Value: "Hello, world!",
        },
      },
    },
  },
)
if err != nil {
  var badRequestErr *vellum.BadRequestError
  if errors.As(err, badRequestErr) {
    // Do something with the bad request ...
  }
  return err
}

If you'd like to wrap the errors with additional information and still retain the ability to access the type with errors.Is and errors.As, you can use the %w directive:

response, err := client.Generate(
  ctx,
  &vellum.ExecutePromptRequest{
    PromptDeploymentName: vellum.String("<invalid-name>"), // Updated to use an invalid deployment name
    Inputs: []*vellum.PromptDeploymentInputRequest{
      {
        Type: "String",
        String: &vellum.StringInputRequest{
          Name:  "<input_a>",
          Value: "Hello, world!",
        },
      },
    },
  },
)
if err != nil {
  return fmt.Errorf("failed to generate response: %w", err)
}

Streaming

Calling any of Vellum's streaming APIs is easy. Simply create a new stream type and read each message returned from the server until it's done:

stream, err := client.ExecutePromptStream(
    context.TODO(),
    &vellum.ExecutePromptStreamRequest{
        PromptDeploymentName: vellum.String("<your-deployment-name>>"),
        Inputs: []*vellum.PromptDeploymentInputRequest{
            {
                Type: "String",
                String: &vellum.StringInputRequest{
                    Name:  "<input_a>",
                    Value: "Hello, world!",
                },
            },
        },
    },
)
if err != nil {
  return nil, err
}

// Make sure to close the stream when you're done reading.
// This is easily handled with defer.
defer stream.Close()

for {
  message, err := stream.Recv()
  if errors.Is(err, io.EOF) {
    // An io.EOF error means the server is done sending messages
    // and should be treated as a success.
    break
  }
  if err != nil {
    // The stream has encountered a non-recoverable error. Propagate the
    // error by simply returning the error like usual.
    return nil, err
  }
  // Do something with the message!
}

In summary, callers of the stream API use stream.Recv() to receive a new message from the stream. The stream is complete when the io.EOF error is returned, and if a non-io.EOF error is returned, it should be treated just like any other non-nil error.

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:

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!

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

Bool returns a pointer to the given bool value.
Byte returns a pointer to the given byte value.
Complex128 returns a pointer to the given complex128 value.
Complex64 returns a pointer to the given complex64 value.
Float32 returns a pointer to the given float32 value.
Float64 returns a pointer to the given float64 value.
Int returns a pointer to the given int value.
Int16 returns a pointer to the given int16 value.
Int32 returns a pointer to the given int32 value.
Int64 returns a pointer to the given int64 value.
Int8 returns a pointer to the given int8 value.
MustParseDate attempts to parse the given string as a date time.Time, and panics upon failure.
MustParseDateTime attempts to parse the given string as a datetime time.Time, and panics upon failure.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Rune returns a pointer to the given rune value.
String returns a pointer to the given string value.
Time returns a pointer to the given time.Time value.
Uint returns a pointer to the given uint value.
Uint16 returns a pointer to the given uint16 value.
Uint32 returns a pointer to the given uint32 value.
Uint64 returns a pointer to the given uint64 value.
Uint8 returns a pointer to the given uint8 value.
Uintptr returns a pointer to the given uintptr value.
UUID returns a pointer to the given uuid.UUID value.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Begins with.
Between.
No description provided by the author
Contains.
Does not begin with.
Does not contain.
Does not end with.
Does not equal.
Ends with.
Equals.
Greater than.
Greater than or equal to.
In.
Less than.
Less than or equal to.
Not between.
No description provided by the author
Not in.
Not null.
Null.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Variables

Environments defines all of the API environments.

# Structs

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
A Node Result Event emitted from an API Node.
No description provided by the author
A list of chat message content items.
No description provided by the author
No description provided by the author
A list of chat message content items.
A user input representing a Vellum Array value.
No description provided by the author
No description provided by the author
A value representing an array of Vellum variable values.
A value representing an array of Vellum variable values.
An audio value that is used in a chat message.
An audio value that is used in a chat message.
A base Vellum primitive value representing audio.
A base Vellum primitive value representing audio.
A base Vellum primitive value representing audio.
No description provided by the author
Basic vectorizer for intfloat/multilingual-e5-large.
Basic vectorizer for intfloat/multilingual-e5-large.
Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.
Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.
Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.
Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.
A user input representing a list of chat messages.
No description provided by the author
A value representing Chat History.
A value representing Chat History.
No description provided by the author
No description provided by the author
No description provided by the author
A block that represents a chat message in a prompt template.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A Node Result Event emitted from a Code Execution Node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A user input representing a Vellum Workspace Secret value.
No description provided by the author
The subset of the metadata tracked by Vellum during Prompt Deployment compilation that the request opted into with `expand_meta`.
A Node Result Event emitted from a Conditional Node.
No description provided by the author
No description provided by the author
No description provided by the author
Information about the Test Case to create.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A user input representing a Vellum Error value.
No description provided by the author
A value representing an Error.
A value representing an Error.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A value representing an array of Vellum variable values.
A value representing Chat History.
A value representing an Error.
A value representing a Function Call.
A value representing a JSON object.
A value representing a number.
A value representing Search Results.
A value representing a string.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A slim representation of a Document Index, as it exists within a Folder.
No description provided by the author
A slim representation of a Folder, as it exists within another Folder.
No description provided by the author
A slim representation of a Prompt Sandbox, as it exists within a Folder.
No description provided by the author
A slim representation of a Test Suite, as it exists within a Folder.
No description provided by the author
A slim representation of a Workflow Sandbox, as it exists within a Folder.
No description provided by the author
No description provided by the author
The final data event returned indicating that the stream has ended and all final resolved values from the model can be found.
The final data event returned indicating that the stream has ended and all final resolved values from the model can be found.
The successful response from the model containing all of the resolved values generated by the prompt.
The successful response from the Workflow execution containing the produced outputs.
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
An event that indicates that the node has fulfilled its execution.
The final resolved function call value.
A function call value that is used in a chat message.
A function call value that is used in a chat message.
The final resolved function call value.
The final resolved function call value.
A user input representing a Vellum Function Call value.
The final resolved function call value.
No description provided by the author
A value representing a Function Call.
A value representing a Function Call.
A block that represents a function definition in a prompt template.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Vectorizer for hkunlp/instructor-xl.
Vectorizer for hkunlp/instructor-xl.
An image value that is used in a chat message.
An image value that is used in a chat message.
A base Vellum primitive value representing an image.
A base Vellum primitive value representing an image.
A base Vellum primitive value representing an image.
No description provided by the author
No description provided by the author
The initial data returned indicating that the response from the model has returned and begun streaming.
The initial data returned indicating that the response from the model has returned and begun streaming.
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
An event that indicates that the node has initiated its execution.
Configuration for using an Instructor vectorizer.
Configuration for using an Instructor vectorizer.
No description provided by the author
A block of Jinja template code that is used to generate a prompt.
A user input representing a JSON object.
No description provided by the author
A value representing a JSON object.
A value representing a JSON object.
No description provided by the author
No description provided by the author
No description provided by the author
A Node Result Event emitted from a Map Node.
No description provided by the author
A Node Result Event emitted from a Merge Node.
No description provided by the author
A deprecated pattern for filtering on metadata.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A Node Result Event emitted from a Metric Node.
No description provided by the author
Named Prompt Sandbox Scenario input value that is of type CHAT_HISTORY.
Named Prompt Sandbox Scenario input value that is of type JSON.
No description provided by the author
Named Prompt Sandbox Scenario input value that is of type STRING.
Named Test Case value that is of type ARRAY.
Named Test Case value that is of type ARRAY.
Named Test Case value that is of type CHAT_HISTORY.
Named Test Case value that is of type CHAT_HISTORY.
Named Test Case value that is of type ERROR.
Named Test Case value that is of type ERROR.
Named Test Case value that is of type FUNCTION_CALL.
Named Test Case value that is of type FUNCTION_CALL.
Named Test Case value that is of type JSON.
Named Test Case value that is of type JSON.
Named Test Case value that is of type NUMBER.
Named Test Case value that is of type NUMBER.
Named Test Case value that is of type SEARCH_RESULTS.
Named Test Case value that is of type SEARCH_RESULTS.
Named Test Case value that is of type STRING.
Named Test Case value that is of type STRING.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An output returned by a node that is of type ARRAY.
An output returned by a node that is of type CHAT_HISTORY.
An output returned by a node that is of type ERROR.
An output returned by a node that is of type FUNCTION_CALL.
An output returned by a node that is of type JSON.
An output returned by a node that is of type NUMBER.
An output returned by a node that is of type SEARCH_RESULTS.
An output returned by a node that is of type STRING.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A user input representing a number value.
No description provided by the author
A value representing a number.
A value representing a number.
Configuration for using an OpenAI vectorizer.
Configuration for using an OpenAI vectorizer.
OpenAI vectorizer for text-embedding-3-large.
OpenAI vectorizer for text-embedding-3-large.
OpenAI vectorizer for text-embedding-3-small.
OpenAI vectorizer for text-embedding-3-small.
OpenAI vectorizer for text-embedding-ada-002.
OpenAI vectorizer for text-embedding-ada-002.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The source of a search result from a PDF document.
The source of a search result from a PDF document.
A block that holds a plain text string value.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
A Node Result Event emitted from a Prompt Node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Configuration for Reducto chunking.
Configuration for Reducto chunking.
Reducto chunking.
Reducto chunking.
The final data returned indicating an error occurred during the stream.
The final data returned indicating an error occurred during the stream.
The unsuccessful response from the model containing an error of what went wrong.
The unsuccessful response from the Workflow execution containing an error specifying what went wrong.
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
An event that indicates that the node has rejected its execution.
Information about the Test Case to replace.
No description provided by the author
A block that includes a combination of plain text and variable blocks.
Sandbox Scenario.
No description provided by the author
Prompt Sandbox Scenario input value that is of type CHAT_HISTORY.
Prompt Sandbox Scenario input value that is of type JSON.
Prompt Sandbox Scenario input value that is of type STRING.
No description provided by the author
A Node Result Event emitted from a Search Node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A user input representing a search results value.
No description provided by the author
A value representing Search Results.
A value representing Search Results.
No description provided by the author
Configuration for sentence chunking.
Configuration for sentence chunking.
Sentence chunking.
Sentence chunking.
No description provided by the author
No description provided by the author
No description provided by the author
The data returned for each delta during the prompt execution stream.
The data returned for each delta during the prompt execution stream.
The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.
An event that indicates that the node has execution is in progress.
A string value that is used in a chat message.
A string value that is used in a chat message.
A user input representing a string value.
No description provided by the author
A value representing a string.
A value representing a string.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A Node Result Event emitted from a Subworkflow Node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A Node Result Event emitted from a Templating Node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A Node Result Event emitted from a Terminal Node.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An Array value for a variable in a Test Case.
A chat history value for a variable in a Test Case.
An error value for a variable in a Test Case.
A function call value for a variable in a Test Case.
A JSON value for a variable in a Test Case.
A numerical value for a variable in a Test Case.
A search results value for a variable in a Test Case.
A string value for a variable in a Test Case.
No description provided by the author
No description provided by the author
Execution configuration for running a Test Suite against a Prompt Deployment.
No description provided by the author
No description provided by the author
Execution configuration for running a Test Suite against a Prompt Deployment.
No description provided by the author
No description provided by the author
No description provided by the author
Execution output of an entity evaluated during a Test Suite Run that is of type ARRAY.
Execution output of an entity evaluated during a Test Suite Run that is of type CHAT_HISTORY.
Execution output of an entity evaluated during a Test Suite Run that is of type ERROR.
Execution output of an entity evaluated during a Test Suite Run that is of type FUNCTION_CALL.
Execution output of an entity evaluated during a Test Suite Run that is of type JSON.
No description provided by the author
No description provided by the author
Execution output of an entity evaluated during a Test Suite Run that is of type NUMBER.
No description provided by the author
Execution output of an entity evaluated during a Test Suite Run that is of type SEARCH_RESULTS.
Execution output of an entity evaluated during a Test Suite Run that is of type STRING.
Execution configuration for running a Vellum Test Suite against an external callable.
No description provided by the author
No description provided by the author
Execution configuration for running a Vellum Test Suite against an external callable.
Output for a test suite run metric that is of type ERROR.
Output for a test suite run metric that is of type NUMBER.
Output for a test suite run metric that is of type NUMBER.
No description provided by the author
Output for a test suite run metric that is of type STRING.
No description provided by the author
No description provided by the author
No description provided by the author
Execution configuration for running a Test Suite against a Workflow Deployment.
No description provided by the author
No description provided by the author
Execution configuration for running a Test Suite against a Workflow Deployment.
No description provided by the author
No description provided by the author
No description provided by the author
A bulk operation that represents the creation of a Test Case.
The result of a bulk operation that created a Test Case.
Information about the Test Case that was created.
No description provided by the author
A bulk operation that represents the deletion of a Test Case.
The result of a bulk operation that deleted a Test Case.
Information about the Test Case that was deleted.
The result of a bulk operation that failed to operate on a Test Case.
A bulk operation that represents the replacing of a Test Case.
The result of a bulk operation that replaced a Test Case.
Information about the Test Case that was replaced.
A bulk operation that represents the upserting of a Test Case.
Configuration for token overlapping window chunking.
Configuration for token overlapping window chunking.
Token overlapping window chunking.
Token overlapping window chunking.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A block that represents a variable in a prompt template.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A higher-order condition that combines one or more basic conditions or other higher-order conditions.
A basic condition comparing two Vellum values.
No description provided by the author
No description provided by the author
No description provided by the author
A set of fields with additional properties for use in Vellum Variables.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A NODE-level event emitted from the workflow's execution.
A WORKFLOW-level event emitted from the workflow's execution.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
An array output from a Workflow execution.
A chat history output from a Workflow execution.
An error output from a Workflow execution.
A function call output from a Workflow execution.
An image output from a Workflow execution.
A JSON output from a Workflow execution.
A number output from a Workflow execution.
A search results output from a Workflow execution.
A string output from a Workflow execution.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The input for a chat history variable in a Workflow.
No description provided by the author
The input for a JSON variable in a Workflow.
The input for a number variable in a Workflow.
The input for a string variable in a Workflow.
No description provided by the author
No description provided by the author
An Array output returned from a Workflow execution.
A Chat History output streamed from a Workflow execution.
An Error output streamed from a Workflow execution.
A Function Call output returned from a Workflow execution.
A JSON output streamed from a Workflow execution.
A number output streamed from a Workflow execution.
A Search Results output streamed from a Workflow execution.
A string output streamed from a Workflow execution.
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

- `True` - True.
- `SYSTEM` - System - `ASSISTANT` - Assistant - `USER` - User - `FUNCTION` - Function.
- `PYTHON_3_11_6` - PYTHON_3_11_6 - `TYPESCRIPT_5_3_3` - TYPESCRIPT_5_3_3.
- `OR` - OR - `AND` - AND.
No description provided by the author
No description provided by the author
- `ACTIVE` - Active.
- `ACTIVE` - Active - `ARCHIVED` - Archived.
- `DEFAULT` - Default - `PUBLIC` - Public - `PRIVATE` - Private - `DISABLED` - Disabled.
- `DEVELOPMENT` - Development - `STAGING` - Staging - `PRODUCTION` - Production.
- `EPHEMERAL` - EPHEMERAL.
- `LENGTH` - LENGTH - `STOP` - STOP - `UNKNOWN` - UNKNOWN.
No description provided by the author
No description provided by the author
- `AWAITING_PROCESSING` - Awaiting Processing - `QUEUED` - Queued - `INDEXING` - Indexing - `INDEXED` - Indexed - `FAILED` - Failed.
- `INITIATED` - INITIATED - `FULFILLED` - FULFILLED - `REJECTED` - REJECTED.
No description provided by the author
No description provided by the author
- `=` - EQUALS - `!=` - DOES_NOT_EQUAL - `<` - LESS_THAN - `>` - GREATER_THAN - `<=` - LESS_THAN_OR_EQUAL_TO - `>=` - GREATER_THAN_OR_EQUAL_TO - `contains` - CONTAINS - `beginsWith` - BEGINS_WITH - `endsWith` - ENDS_WITH - `doesNotContain` - DOES_NOT_CONTAIN - `doesNotBeginWith` - DOES_NOT_BEGIN_WITH - `doesNotEndWith` - DOES_NOT_END_WITH - `null` - NULL - `notNull` - NOT_NULL - `in` - IN - `notIn` - NOT_IN - `between` - BETWEEN - `notBetween` - NOT_BETWEEN - `blank` - BLANK - `notBlank` - NOT_BLANK.
- `ALL` - ALL - `NONE` - NONE.
- `and` - AND - `or` - OR.
- `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit - `INVALID_FILE` - Invalid File.
- `QUEUED` - Queued - `PROCESSING` - Processing - `PROCESSED` - Processed - `FAILED` - Failed.
- `ENABLED` - ENABLED - `DISABLED` - DISABLED.
- `SYSTEM` - System - `USER` - User.
- `USER_DEFINED` - User Defined - `HMAC` - Hmac - `INTERNAL_API_KEY` - Internal Api Key.
- `QUEUED` - Queued - `RUNNING` - Running - `COMPLETE` - Complete - `FAILED` - Failed - `CANCELLED` - Cancelled.
- `USD` - USD.
- `INVALID_REQUEST` - INVALID_REQUEST - `PROVIDER_ERROR` - PROVIDER_ERROR - `REQUEST_TIMEOUT` - REQUEST_TIMEOUT - `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR - `USER_DEFINED_ERROR` - USER_DEFINED_ERROR.
- `STRING` - STRING - `NUMBER` - NUMBER - `JSON` - JSON - `CHAT_HISTORY` - CHAT_HISTORY - `SEARCH_RESULTS` - SEARCH_RESULTS - `ERROR` - ERROR - `ARRAY` - ARRAY - `FUNCTION_CALL` - FUNCTION_CALL - `IMAGE` - IMAGE - `AUDIO` - AUDIO - `NULL` - NULL.
No description provided by the author
- `WORKFLOW_INITIALIZATION` - WORKFLOW_INITIALIZATION - `WORKFLOW_CANCELLED` - WORKFLOW_CANCELLED - `NODE_EXECUTION_COUNT_LIMIT_REACHED` - NODE_EXECUTION_COUNT_LIMIT_REACHED - `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR - `NODE_EXECUTION` - NODE_EXECUTION - `LLM_PROVIDER` - LLM_PROVIDER - `INVALID_TEMPLATE` - INVALID_TEMPLATE - `USER_DEFINED_ERROR` - USER_DEFINED_ERROR.
- `NODE` - NODE - `WORKFLOW` - WORKFLOW.
- `INITIATED` - INITIATED - `STREAMING` - STREAMING - `FULFILLED` - FULFILLED - `REJECTED` - REJECTED.
No description provided by the author
No description provided by the author