api

package module
v0.6.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 29, 2024 License: MIT Imports: 4 Imported by: 0

README

Vellum Go Library

fern shield 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.Generate(
  context.TODO(),
  &vellum.GenerateBodyRequest{
    DeploymentName: vellum.String("example"),
    Requests: []*vellum.GenerateRequest{
      {
        InputValues: map[string]interface{}{
          "whoami":   "John Doe",
          "question": "What is my name?",
        },
      },
    },
  },
)

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.Generate(
  ctx,
  &vellum.GenerateBodyRequest{
    DeploymentName: vellum.String("example"),
    Requests: []*vellum.GenerateRequest{
      {
        InputValues: map[string]interface{}{
          "whoami":   "John Doe",
          "question": "What is my name?",
        },
      },
    },
  },
)

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.Generate(
  ctx,
  &vellum.GenerateBodyRequest{
    DeploymentName: vellum.String("invalid"),
    Requests: []*vellum.GenerateRequest{
      {
        InputValues: map[string]interface{}{
          "whoami":   "John Doe",
          "question": "What is my name?",
        },
      },
    },
  },
)
if err != nil {
  if badRequestErr, ok := err.(*vellum.BadRequestError);
    // Do something with the bad request ...
  }
  return err
}

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.GenerateBodyRequest{
    DeploymentName: vellum.String("invalid"),
    Requests: []*vellum.GenerateRequest{
      {
        InputValues: map[string]interface{}{
          "whoami":   "John Doe",
          "question": "What is my name?",
        },
      },
    },
  },
)
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.GenerateBodyRequest{
    DeploymentName: vellum.String("invalid"),
    Requests: []*vellum.GenerateRequest{
      {
        InputValues: map[string]interface{}{
          "whoami":   "John Doe",
          "question": "What is my name?",
        },
      },
    },
  },
)
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.GenerateStream(
  context.TODO(),
  &vellum.GenerateStreamBodyRequest{
    DeploymentName: vellum.String("example"),
    Requests: []*vellum.GenerateRequest{
      InputValues: map[string]interface{}{
        "whoami":   "John Doe",
        "question": "Could you write me a long story?",
      },
    },
  },
)
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.

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. This way, you can install the same version each time without breaking changes.

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!

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Environments = struct {
	Production struct {
		Default   string
		Documents string
		Predict   string
	}
}{
	Production: struct {
		Default   string
		Documents string
		Predict   string
	}{
		Default:   "https://api.vellum.ai",
		Documents: "https://documents.vellum.ai",
		Predict:   "https://predict.vellum.ai",
	},
}

Environments defines all of the API environments. These values can be used with the WithBaseURL ClientOption to override the client's default environment, if any.

Functions

func Bool 

func Bool(b bool) *bool

Bool returns a pointer to the given bool value.

func Byte 

func Byte(b byte) *byte

Byte returns a pointer to the given byte value.

func Complex128 

func Complex128(c complex128) *complex128

Complex128 returns a pointer to the given complex128 value.

func Complex64 

func Complex64(c complex64) *complex64

Complex64 returns a pointer to the given complex64 value.

func Float32 

func Float32(f float32) *float32

Float32 returns a pointer to the given float32 value.

func Float64 

func Float64(f float64) *float64

Float64 returns a pointer to the given float64 value.

func Int 

func Int(i int) *int

Int returns a pointer to the given int value.

func Int16 

func Int16(i int16) *int16

Int16 returns a pointer to the given int16 value.

func Int32 

func Int32(i int32) *int32

Int32 returns a pointer to the given int32 value.

func Int64 

func Int64(i int64) *int64

Int64 returns a pointer to the given int64 value.

func Int8 

func Int8(i int8) *int8

Int8 returns a pointer to the given int8 value.

func Rune 

func Rune(r rune) *rune

Rune returns a pointer to the given rune value.

func String 

func String(s string) *string

String returns a pointer to the given string value.

func Time 

func Time(t time.Time) *time.Time

Time returns a pointer to the given time.Time value.

func Uint 

func Uint(u uint) *uint

Uint returns a pointer to the given uint value.

func Uint16 

func Uint16(u uint16) *uint16

Uint16 returns a pointer to the given uint16 value.

func Uint32 

func Uint32(u uint32) *uint32

Uint32 returns a pointer to the given uint32 value.

func Uint64 

func Uint64(u uint64) *uint64

Uint64 returns a pointer to the given uint64 value.

func Uint8 

func Uint8(u uint8) *uint8

Uint8 returns a pointer to the given uint8 value.

func Uintptr 

func Uintptr(u uintptr) *uintptr

Uintptr returns a pointer to the given uintptr value.

Types

type AddEntityToFolderRequest added in v0.3.7 

type AddEntityToFolderRequest struct {
	// The ID of the entity you would like to move.
	EntityId string `json:"entity_id"`
}

type AddOpenaiApiKeyEnum added in v0.6.0 

type AddOpenaiApiKeyEnum = bool

- `True` - True

type ApiNodeResult 

type ApiNodeResult struct {
	Data *ApiNodeResultData `json:"data,omitempty"`
	// contains filtered or unexported fields
}

A Node Result Event emitted from an API Node.

func (*ApiNodeResult) String 

func (a *ApiNodeResult) String() string

func (*ApiNodeResult) UnmarshalJSON 

func (a *ApiNodeResult) UnmarshalJSON(data []byte) error

type ApiNodeResultData 

type ApiNodeResultData struct {
	TextOutputId       string                 `json:"text_output_id"`
	Text               *string                `json:"text,omitempty"`
	JsonOutputId       string                 `json:"json_output_id"`
	Json               map[string]interface{} `json:"json,omitempty"`
	StatusCodeOutputId string                 `json:"status_code_output_id"`
	StatusCode         int                    `json:"status_code"`
	// contains filtered or unexported fields
}

func (*ApiNodeResultData) String 

func (a *ApiNodeResultData) String() string

func (*ApiNodeResultData) UnmarshalJSON 

func (a *ApiNodeResultData) UnmarshalJSON(data []byte) error

type ArrayChatMessageContent added in v0.2.0 

type ArrayChatMessageContent struct {
	Value []*ArrayChatMessageContentItem `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A list of chat message content items.

func (*ArrayChatMessageContent) String added in v0.2.0 

func (a *ArrayChatMessageContent) String() string

func (*ArrayChatMessageContent) UnmarshalJSON added in v0.2.0 

func (a *ArrayChatMessageContent) UnmarshalJSON(data []byte) error

type ArrayChatMessageContentItem added in v0.2.0 

type ArrayChatMessageContentItem struct {
	Type         string
	String       *StringChatMessageContent
	FunctionCall *FunctionCallChatMessageContent
	Image        *ImageChatMessageContent
}

func NewArrayChatMessageContentItemFromFunctionCall added in v0.2.0 

func NewArrayChatMessageContentItemFromFunctionCall(value *FunctionCallChatMessageContent) *ArrayChatMessageContentItem

func NewArrayChatMessageContentItemFromImage added in v0.2.0 

func NewArrayChatMessageContentItemFromImage(value *ImageChatMessageContent) *ArrayChatMessageContentItem

func NewArrayChatMessageContentItemFromString added in v0.2.0 

func NewArrayChatMessageContentItemFromString(value *StringChatMessageContent) *ArrayChatMessageContentItem

func (*ArrayChatMessageContentItem) Accept added in v0.2.0 

func (a *ArrayChatMessageContentItem) Accept(visitor ArrayChatMessageContentItemVisitor) error

func (ArrayChatMessageContentItem) MarshalJSON added in v0.2.0 

func (a ArrayChatMessageContentItem) MarshalJSON() ([]byte, error)

func (*ArrayChatMessageContentItem) UnmarshalJSON added in v0.2.0 

func (a *ArrayChatMessageContentItem) UnmarshalJSON(data []byte) error

type ArrayChatMessageContentItemRequest added in v0.2.0 

type ArrayChatMessageContentItemRequest struct {
	Type         string
	String       *StringChatMessageContentRequest
	FunctionCall *FunctionCallChatMessageContentRequest
	Image        *ImageChatMessageContentRequest
}

func NewArrayChatMessageContentItemRequestFromFunctionCall added in v0.2.0 

func NewArrayChatMessageContentItemRequestFromFunctionCall(value *FunctionCallChatMessageContentRequest) *ArrayChatMessageContentItemRequest

func NewArrayChatMessageContentItemRequestFromImage added in v0.2.0 

func NewArrayChatMessageContentItemRequestFromImage(value *ImageChatMessageContentRequest) *ArrayChatMessageContentItemRequest

func NewArrayChatMessageContentItemRequestFromString added in v0.2.0 

func NewArrayChatMessageContentItemRequestFromString(value *StringChatMessageContentRequest) *ArrayChatMessageContentItemRequest

func (*ArrayChatMessageContentItemRequest) Accept added in v0.2.0 

func (a *ArrayChatMessageContentItemRequest) Accept(visitor ArrayChatMessageContentItemRequestVisitor) error

func (ArrayChatMessageContentItemRequest) MarshalJSON added in v0.2.0 

func (a ArrayChatMessageContentItemRequest) MarshalJSON() ([]byte, error)

func (*ArrayChatMessageContentItemRequest) UnmarshalJSON added in v0.2.0 

func (a *ArrayChatMessageContentItemRequest) UnmarshalJSON(data []byte) error

type ArrayChatMessageContentItemRequestVisitor added in v0.2.0 

type ArrayChatMessageContentItemRequestVisitor interface {
	VisitString(*StringChatMessageContentRequest) error
	VisitFunctionCall(*FunctionCallChatMessageContentRequest) error
	VisitImage(*ImageChatMessageContentRequest) error
}

type ArrayChatMessageContentItemVisitor added in v0.2.0 

type ArrayChatMessageContentItemVisitor interface {
	VisitString(*StringChatMessageContent) error
	VisitFunctionCall(*FunctionCallChatMessageContent) error
	VisitImage(*ImageChatMessageContent) error
}

type ArrayChatMessageContentRequest added in v0.2.0 

type ArrayChatMessageContentRequest struct {
	Value []*ArrayChatMessageContentItemRequest `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A list of chat message content items.

func (*ArrayChatMessageContentRequest) String added in v0.2.0 

func (a *ArrayChatMessageContentRequest) String() string

func (*ArrayChatMessageContentRequest) UnmarshalJSON added in v0.2.0 

func (a *ArrayChatMessageContentRequest) UnmarshalJSON(data []byte) error

type ArrayEnum added in v0.2.1 

type ArrayEnum = string

type ArrayVariableValueItem added in v0.3.8 

type ArrayVariableValueItem struct {
	Type         string
	String       *StringVariableValue
	Number       *NumberVariableValue
	Json         *JsonVariableValue
	Error        *ErrorVariableValue
	FunctionCall *FunctionCallVariableValue
	Image        *ImageVariableValue
}

func NewArrayVariableValueItemFromError added in v0.3.8 

func NewArrayVariableValueItemFromError(value *ErrorVariableValue) *ArrayVariableValueItem

func NewArrayVariableValueItemFromFunctionCall added in v0.3.8 

func NewArrayVariableValueItemFromFunctionCall(value *FunctionCallVariableValue) *ArrayVariableValueItem

func NewArrayVariableValueItemFromImage added in v0.3.12 

func NewArrayVariableValueItemFromImage(value *ImageVariableValue) *ArrayVariableValueItem

func NewArrayVariableValueItemFromJson added in v0.3.8 

func NewArrayVariableValueItemFromJson(value *JsonVariableValue) *ArrayVariableValueItem

func NewArrayVariableValueItemFromNumber added in v0.3.8 

func NewArrayVariableValueItemFromNumber(value *NumberVariableValue) *ArrayVariableValueItem

func NewArrayVariableValueItemFromString added in v0.3.8 

func NewArrayVariableValueItemFromString(value *StringVariableValue) *ArrayVariableValueItem

func (*ArrayVariableValueItem) Accept added in v0.3.8 

func (a *ArrayVariableValueItem) Accept(visitor ArrayVariableValueItemVisitor) error

func (ArrayVariableValueItem) MarshalJSON added in v0.3.8 

func (a ArrayVariableValueItem) MarshalJSON() ([]byte, error)

func (*ArrayVariableValueItem) UnmarshalJSON added in v0.3.8 

func (a *ArrayVariableValueItem) UnmarshalJSON(data []byte) error

type ArrayVariableValueItemVisitor added in v0.3.8 

type ArrayVariableValueItemVisitor interface {
	VisitString(*StringVariableValue) error
	VisitNumber(*NumberVariableValue) error
	VisitJson(*JsonVariableValue) error
	VisitError(*ErrorVariableValue) error
	VisitFunctionCall(*FunctionCallVariableValue) error
	VisitImage(*ImageVariableValue) error
}

type ArrayVellumValueItem added in v0.6.0 

type ArrayVellumValueItem struct {
	Type         string
	String       *StringVellumValue
	Number       *NumberVellumValue
	Json         *JsonVellumValue
	Image        *ImageVellumValue
	FunctionCall *FunctionCallVellumValue
	Error        *ErrorVellumValue
}

func NewArrayVellumValueItemFromError added in v0.6.0 

func NewArrayVellumValueItemFromError(value *ErrorVellumValue) *ArrayVellumValueItem

func NewArrayVellumValueItemFromFunctionCall added in v0.6.0 

func NewArrayVellumValueItemFromFunctionCall(value *FunctionCallVellumValue) *ArrayVellumValueItem

func NewArrayVellumValueItemFromImage added in v0.6.0 

func NewArrayVellumValueItemFromImage(value *ImageVellumValue) *ArrayVellumValueItem

func NewArrayVellumValueItemFromJson added in v0.6.0 

func NewArrayVellumValueItemFromJson(value *JsonVellumValue) *ArrayVellumValueItem

func NewArrayVellumValueItemFromNumber added in v0.6.0 

func NewArrayVellumValueItemFromNumber(value *NumberVellumValue) *ArrayVellumValueItem

func NewArrayVellumValueItemFromString added in v0.6.0 

func NewArrayVellumValueItemFromString(value *StringVellumValue) *ArrayVellumValueItem

func (*ArrayVellumValueItem) Accept added in v0.6.0 

func (a *ArrayVellumValueItem) Accept(visitor ArrayVellumValueItemVisitor) error

func (ArrayVellumValueItem) MarshalJSON added in v0.6.0 

func (a ArrayVellumValueItem) MarshalJSON() ([]byte, error)

func (*ArrayVellumValueItem) UnmarshalJSON added in v0.6.0 

func (a *ArrayVellumValueItem) UnmarshalJSON(data []byte) error

type ArrayVellumValueItemVisitor added in v0.6.0 

type ArrayVellumValueItemVisitor interface {
	VisitString(*StringVellumValue) error
	VisitNumber(*NumberVellumValue) error
	VisitJson(*JsonVellumValue) error
	VisitImage(*ImageVellumValue) error
	VisitFunctionCall(*FunctionCallVellumValue) error
	VisitError(*ErrorVellumValue) error
}

type BadRequestError 

type BadRequestError struct {
	*core.APIError
	Body interface{}
}

func (*BadRequestError) MarshalJSON 

func (b *BadRequestError) MarshalJSON() ([]byte, error)

func (*BadRequestError) UnmarshalJSON 

func (b *BadRequestError) UnmarshalJSON(data []byte) error

func (*BadRequestError) Unwrap 

func (b *BadRequestError) Unwrap() error

type BasicVectorizerIntfloatMultilingualE5Large added in v0.6.0 

type BasicVectorizerIntfloatMultilingualE5Large struct {
	Config map[string]interface{} `json:"config,omitempty"`
	// contains filtered or unexported fields
}

Basic vectorizer for intfloat/multilingual-e5-large.

func (*BasicVectorizerIntfloatMultilingualE5Large) String added in v0.6.0 

func (b *BasicVectorizerIntfloatMultilingualE5Large) String() string

func (*BasicVectorizerIntfloatMultilingualE5Large) UnmarshalJSON added in v0.6.0 

func (b *BasicVectorizerIntfloatMultilingualE5Large) UnmarshalJSON(data []byte) error

type BasicVectorizerIntfloatMultilingualE5LargeRequest added in v0.6.0 

type BasicVectorizerIntfloatMultilingualE5LargeRequest struct {
	Config map[string]interface{} `json:"config,omitempty"`
	// contains filtered or unexported fields
}

Basic vectorizer for intfloat/multilingual-e5-large.

func (*BasicVectorizerIntfloatMultilingualE5LargeRequest) String added in v0.6.0 

func (b *BasicVectorizerIntfloatMultilingualE5LargeRequest) String() string

func (*BasicVectorizerIntfloatMultilingualE5LargeRequest) UnmarshalJSON added in v0.6.0 

func (b *BasicVectorizerIntfloatMultilingualE5LargeRequest) UnmarshalJSON(data []byte) error

type BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1 added in v0.6.0 

type BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1 struct {
	Config map[string]interface{} `json:"config,omitempty"`
	// contains filtered or unexported fields
}

Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.

func (*BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1) String added in v0.6.0 

func (b *BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1) String() string

func (*BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1) UnmarshalJSON added in v0.6.0 

func (b *BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1) UnmarshalJSON(data []byte) error

type BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request added in v0.6.0 

type BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request struct {
	Config map[string]interface{} `json:"config,omitempty"`
	// contains filtered or unexported fields
}

Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-cos-v1.

func (*BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request) String added in v0.6.0 

func (b *BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request) String() string

func (*BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request) UnmarshalJSON added in v0.6.0 

func (b *BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request) UnmarshalJSON(data []byte) error

type BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1 added in v0.6.0 

type BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1 struct {
	Config map[string]interface{} `json:"config,omitempty"`
	// contains filtered or unexported fields
}

Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.

func (*BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1) String added in v0.6.0 

func (b *BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1) String() string

func (*BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1) UnmarshalJSON added in v0.6.0 

func (b *BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1) UnmarshalJSON(data []byte) error

type BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request added in v0.6.0 

type BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request struct {
	Config map[string]interface{} `json:"config,omitempty"`
	// contains filtered or unexported fields
}

Basic vectorizer for sentence-transformers/multi-qa-mpnet-base-dot-v1.

func (*BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request) String added in v0.6.0 

func (b *BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request) String() string

func (*BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request) UnmarshalJSON added in v0.6.0 

func (b *BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request) UnmarshalJSON(data []byte) error

type ChatHistoryEnum added in v0.2.1 

type ChatHistoryEnum = string

type ChatHistoryInputRequest 

type ChatHistoryInputRequest struct {
	// The variable's name, as defined in the deployment.
	Name  string                `json:"name"`
	Value []*ChatMessageRequest `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A user input representing a list of chat messages

func (*ChatHistoryInputRequest) String 

func (c *ChatHistoryInputRequest) String() string

func (*ChatHistoryInputRequest) UnmarshalJSON 

func (c *ChatHistoryInputRequest) UnmarshalJSON(data []byte) error

type ChatMessage 

type ChatMessage struct {
	Text    *string             `json:"text,omitempty"`
	Role    ChatMessageRole     `json:"role,omitempty"`
	Content *ChatMessageContent `json:"content,omitempty"`
	// An optional identifier representing who or what generated this message.
	Source *string `json:"source,omitempty"`
	// contains filtered or unexported fields
}

func (*ChatMessage) String 

func (c *ChatMessage) String() string

func (*ChatMessage) UnmarshalJSON 

func (c *ChatMessage) UnmarshalJSON(data []byte) error

type ChatMessageContent added in v0.2.0 

type ChatMessageContent struct {
	Type         string
	String       *StringChatMessageContent
	FunctionCall *FunctionCallChatMessageContent
	Array        *ArrayChatMessageContent
	Image        *ImageChatMessageContent
}

func NewChatMessageContentFromArray added in v0.2.0 

func NewChatMessageContentFromArray(value *ArrayChatMessageContent) *ChatMessageContent

func NewChatMessageContentFromFunctionCall added in v0.2.0 

func NewChatMessageContentFromFunctionCall(value *FunctionCallChatMessageContent) *ChatMessageContent

func NewChatMessageContentFromImage added in v0.2.0 

func NewChatMessageContentFromImage(value *ImageChatMessageContent) *ChatMessageContent

func NewChatMessageContentFromString added in v0.2.0 

func NewChatMessageContentFromString(value *StringChatMessageContent) *ChatMessageContent

func (*ChatMessageContent) Accept added in v0.2.0 

func (c *ChatMessageContent) Accept(visitor ChatMessageContentVisitor) error

func (ChatMessageContent) MarshalJSON added in v0.2.0 

func (c ChatMessageContent) MarshalJSON() ([]byte, error)

func (*ChatMessageContent) UnmarshalJSON added in v0.2.0 

func (c *ChatMessageContent) UnmarshalJSON(data []byte) error

type ChatMessageContentRequest added in v0.2.0 

type ChatMessageContentRequest struct {
	Type         string
	String       *StringChatMessageContentRequest
	FunctionCall *FunctionCallChatMessageContentRequest
	Array        *ArrayChatMessageContentRequest
	Image        *ImageChatMessageContentRequest
}

func NewChatMessageContentRequestFromArray added in v0.2.0 

func NewChatMessageContentRequestFromArray(value *ArrayChatMessageContentRequest) *ChatMessageContentRequest

func NewChatMessageContentRequestFromFunctionCall added in v0.2.0 

func NewChatMessageContentRequestFromFunctionCall(value *FunctionCallChatMessageContentRequest) *ChatMessageContentRequest

func NewChatMessageContentRequestFromImage added in v0.2.0 

func NewChatMessageContentRequestFromImage(value *ImageChatMessageContentRequest) *ChatMessageContentRequest

func NewChatMessageContentRequestFromString added in v0.2.0 

func NewChatMessageContentRequestFromString(value *StringChatMessageContentRequest) *ChatMessageContentRequest

func (*ChatMessageContentRequest) Accept added in v0.2.0 

func (c *ChatMessageContentRequest) Accept(visitor ChatMessageContentRequestVisitor) error

func (ChatMessageContentRequest) MarshalJSON added in v0.2.0 

func (c ChatMessageContentRequest) MarshalJSON() ([]byte, error)

func (*ChatMessageContentRequest) UnmarshalJSON added in v0.2.0 

func (c *ChatMessageContentRequest) UnmarshalJSON(data []byte) error

type ChatMessageContentRequestVisitor added in v0.2.0 

type ChatMessageContentRequestVisitor interface {
	VisitString(*StringChatMessageContentRequest) error
	VisitFunctionCall(*FunctionCallChatMessageContentRequest) error
	VisitArray(*ArrayChatMessageContentRequest) error
	VisitImage(*ImageChatMessageContentRequest) error
}

type ChatMessageContentVisitor added in v0.2.0 

type ChatMessageContentVisitor interface {
	VisitString(*StringChatMessageContent) error
	VisitFunctionCall(*FunctionCallChatMessageContent) error
	VisitArray(*ArrayChatMessageContent) error
	VisitImage(*ImageChatMessageContent) error
}

type ChatMessageRequest 

type ChatMessageRequest struct {
	Text    *string                    `json:"text,omitempty"`
	Role    ChatMessageRole            `json:"role,omitempty"`
	Content *ChatMessageContentRequest `json:"content,omitempty"`
	// An optional identifier representing who or what generated this message.
	Source *string `json:"source,omitempty"`
	// contains filtered or unexported fields
}

func (*ChatMessageRequest) String 

func (c *ChatMessageRequest) String() string

func (*ChatMessageRequest) UnmarshalJSON 

func (c *ChatMessageRequest) UnmarshalJSON(data []byte) error

type ChatMessageRole 

type ChatMessageRole string

- `SYSTEM` - System - `ASSISTANT` - Assistant - `USER` - User - `FUNCTION` - Function 

const (
	ChatMessageRoleSystem    ChatMessageRole = "SYSTEM"
	ChatMessageRoleAssistant ChatMessageRole = "ASSISTANT"
	ChatMessageRoleUser      ChatMessageRole = "USER"
	ChatMessageRoleFunction  ChatMessageRole = "FUNCTION"
)

func NewChatMessageRoleFromString 

func NewChatMessageRoleFromString(s string) (ChatMessageRole, error)

func (ChatMessageRole) Ptr 

func (c ChatMessageRole) Ptr() *ChatMessageRole

type CodeExecutionNodeArrayResult added in v0.3.15 

type CodeExecutionNodeArrayResult struct {
	Id    string                    `json:"id"`
	Value []*ArrayVariableValueItem `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*CodeExecutionNodeArrayResult) String added in v0.3.15 

func (c *CodeExecutionNodeArrayResult) String() string

func (*CodeExecutionNodeArrayResult) UnmarshalJSON added in v0.3.15 

func (c *CodeExecutionNodeArrayResult) UnmarshalJSON(data []byte) error

type CodeExecutionNodeChatHistoryResult 

type CodeExecutionNodeChatHistoryResult struct {
	Id    string         `json:"id"`
	Value []*ChatMessage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*CodeExecutionNodeChatHistoryResult) String 

func (c *CodeExecutionNodeChatHistoryResult) String() string

func (*CodeExecutionNodeChatHistoryResult) UnmarshalJSON 

func (c *CodeExecutionNodeChatHistoryResult) UnmarshalJSON(data []byte) error

type CodeExecutionNodeErrorResult 

type CodeExecutionNodeErrorResult struct {
	Id    string       `json:"id"`
	Value *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*CodeExecutionNodeErrorResult) String 

func (c *CodeExecutionNodeErrorResult) String() string

func (*CodeExecutionNodeErrorResult) UnmarshalJSON 

func (c *CodeExecutionNodeErrorResult) UnmarshalJSON(data []byte) error

type CodeExecutionNodeFunctionCallResult added in v0.3.15 

type CodeExecutionNodeFunctionCallResult struct {
	Id    string        `json:"id"`
	Value *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*CodeExecutionNodeFunctionCallResult) String added in v0.3.15 

func (c *CodeExecutionNodeFunctionCallResult) String() string

func (*CodeExecutionNodeFunctionCallResult) UnmarshalJSON added in v0.3.15 

func (c *CodeExecutionNodeFunctionCallResult) UnmarshalJSON(data []byte) error

type CodeExecutionNodeJsonResult 

type CodeExecutionNodeJsonResult struct {
	Id    string                 `json:"id"`
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*CodeExecutionNodeJsonResult) String 

func (c *CodeExecutionNodeJsonResult) String() string

func (*CodeExecutionNodeJsonResult) UnmarshalJSON 

func (c *CodeExecutionNodeJsonResult) UnmarshalJSON(data []byte) error

type CodeExecutionNodeNumberResult 

type CodeExecutionNodeNumberResult struct {
	Id    string   `json:"id"`
	Value *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*CodeExecutionNodeNumberResult) String 

func (c *CodeExecutionNodeNumberResult) String() string

func (*CodeExecutionNodeNumberResult) UnmarshalJSON 

func (c *CodeExecutionNodeNumberResult) UnmarshalJSON(data []byte) error

type CodeExecutionNodeResult 

type CodeExecutionNodeResult struct {
	Data *CodeExecutionNodeResultData `json:"data,omitempty"`
	// contains filtered or unexported fields
}

A Node Result Event emitted from a Code Execution Node.

func (*CodeExecutionNodeResult) String 

func (c *CodeExecutionNodeResult) String() string

func (*CodeExecutionNodeResult) UnmarshalJSON 

func (c *CodeExecutionNodeResult) UnmarshalJSON(data []byte) error

type CodeExecutionNodeResultData 

type CodeExecutionNodeResultData struct {
	Output      *CodeExecutionNodeResultOutput `json:"output,omitempty"`
	LogOutputId *string                        `json:"log_output_id,omitempty"`
	// contains filtered or unexported fields
}

func (*CodeExecutionNodeResultData) String 

func (c *CodeExecutionNodeResultData) String() string

func (*CodeExecutionNodeResultData) UnmarshalJSON 

func (c *CodeExecutionNodeResultData) UnmarshalJSON(data []byte) error

type CodeExecutionNodeResultOutput 

type CodeExecutionNodeResultOutput struct {
	Type          string
	String        *CodeExecutionNodeStringResult
	Number        *CodeExecutionNodeNumberResult
	Json          *CodeExecutionNodeJsonResult
	ChatHistory   *CodeExecutionNodeChatHistoryResult
	SearchResults *CodeExecutionNodeSearchResultsResult
	Error         *CodeExecutionNodeErrorResult
	Array         *CodeExecutionNodeArrayResult
	FunctionCall  *CodeExecutionNodeFunctionCallResult
}

func NewCodeExecutionNodeResultOutputFromArray added in v0.3.15 

func NewCodeExecutionNodeResultOutputFromArray(value *CodeExecutionNodeArrayResult) *CodeExecutionNodeResultOutput

func NewCodeExecutionNodeResultOutputFromChatHistory 

func NewCodeExecutionNodeResultOutputFromChatHistory(value *CodeExecutionNodeChatHistoryResult) *CodeExecutionNodeResultOutput

func NewCodeExecutionNodeResultOutputFromError 

func NewCodeExecutionNodeResultOutputFromError(value *CodeExecutionNodeErrorResult) *CodeExecutionNodeResultOutput

func NewCodeExecutionNodeResultOutputFromFunctionCall added in v0.3.15 

func NewCodeExecutionNodeResultOutputFromFunctionCall(value *CodeExecutionNodeFunctionCallResult) *CodeExecutionNodeResultOutput

func NewCodeExecutionNodeResultOutputFromJson 

func NewCodeExecutionNodeResultOutputFromJson(value *CodeExecutionNodeJsonResult) *CodeExecutionNodeResultOutput

func NewCodeExecutionNodeResultOutputFromNumber 

func NewCodeExecutionNodeResultOutputFromNumber(value *CodeExecutionNodeNumberResult) *CodeExecutionNodeResultOutput

func NewCodeExecutionNodeResultOutputFromSearchResults 

func NewCodeExecutionNodeResultOutputFromSearchResults(value *CodeExecutionNodeSearchResultsResult) *CodeExecutionNodeResultOutput

func NewCodeExecutionNodeResultOutputFromString 

func NewCodeExecutionNodeResultOutputFromString(value *CodeExecutionNodeStringResult) *CodeExecutionNodeResultOutput

func (*CodeExecutionNodeResultOutput) Accept 

func (c *CodeExecutionNodeResultOutput) Accept(visitor CodeExecutionNodeResultOutputVisitor) error

func (CodeExecutionNodeResultOutput) MarshalJSON 

func (c CodeExecutionNodeResultOutput) MarshalJSON() ([]byte, error)

func (*CodeExecutionNodeResultOutput) UnmarshalJSON 

func (c *CodeExecutionNodeResultOutput) UnmarshalJSON(data []byte) error

type CodeExecutionNodeResultOutputVisitor 

type CodeExecutionNodeResultOutputVisitor interface {
	VisitString(*CodeExecutionNodeStringResult) error
	VisitNumber(*CodeExecutionNodeNumberResult) error
	VisitJson(*CodeExecutionNodeJsonResult) error
	VisitChatHistory(*CodeExecutionNodeChatHistoryResult) error
	VisitSearchResults(*CodeExecutionNodeSearchResultsResult) error
	VisitError(*CodeExecutionNodeErrorResult) error
	VisitArray(*CodeExecutionNodeArrayResult) error
	VisitFunctionCall(*CodeExecutionNodeFunctionCallResult) error
}

type CodeExecutionNodeSearchResultsResult 

type CodeExecutionNodeSearchResultsResult struct {
	Id    string          `json:"id"`
	Value []*SearchResult `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*CodeExecutionNodeSearchResultsResult) String 

func (c *CodeExecutionNodeSearchResultsResult) String() string

func (*CodeExecutionNodeSearchResultsResult) UnmarshalJSON 

func (c *CodeExecutionNodeSearchResultsResult) UnmarshalJSON(data []byte) error

type CodeExecutionNodeStringResult 

type CodeExecutionNodeStringResult struct {
	Id    string  `json:"id"`
	Value *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*CodeExecutionNodeStringResult) String 

func (c *CodeExecutionNodeStringResult) String() string

func (*CodeExecutionNodeStringResult) UnmarshalJSON 

func (c *CodeExecutionNodeStringResult) UnmarshalJSON(data []byte) error

type ConditionalNodeResult 

type ConditionalNodeResult struct {
	Data *ConditionalNodeResultData `json:"data,omitempty"`
	// contains filtered or unexported fields
}

A Node Result Event emitted from a Conditional Node.

func (*ConditionalNodeResult) String 

func (c *ConditionalNodeResult) String() string

func (*ConditionalNodeResult) UnmarshalJSON 

func (c *ConditionalNodeResult) UnmarshalJSON(data []byte) error

type ConditionalNodeResultData 

type ConditionalNodeResultData struct {
	SourceHandleId *string `json:"source_handle_id,omitempty"`
	// contains filtered or unexported fields
}

func (*ConditionalNodeResultData) String 

func (c *ConditionalNodeResultData) String() string

func (*ConditionalNodeResultData) UnmarshalJSON 

func (c *ConditionalNodeResultData) UnmarshalJSON(data []byte) error

type DeploymentProviderPayloadRequest 

type DeploymentProviderPayloadRequest struct {
	// The ID of the deployment. Must provide either this or deployment_name.
	DeploymentId *string `json:"deployment_id,omitempty"`
	// The name of the deployment. Must provide either this or deployment_id.
	DeploymentName *string `json:"deployment_name,omitempty"`
	// The list of inputs defined in the Prompt's deployment with their corresponding values.
	Inputs []*PromptDeploymentInputRequest `json:"inputs,omitempty"`
	// Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
	ReleaseTag *string `json:"release_tag,omitempty"`
}

type DeploymentProviderPayloadResponse 

type DeploymentProviderPayloadResponse struct {
	Payload map[string]interface{} `json:"payload,omitempty"`
	// contains filtered or unexported fields
}

func (*DeploymentProviderPayloadResponse) String 

func (d *DeploymentProviderPayloadResponse) String() string

func (*DeploymentProviderPayloadResponse) UnmarshalJSON 

func (d *DeploymentProviderPayloadResponse) UnmarshalJSON(data []byte) error

type DeploymentRead 

type DeploymentRead struct {
	Id      string    `json:"id"`
	Created time.Time `json:"created"`
	// A human-readable label for the deployment
	Label string `json:"label"`
	// A name that uniquely identifies this deployment within its workspace
	Name string `json:"name"`
	// The current status of the deployment
	//
	// - `ACTIVE` - Active
	// - `ARCHIVED` - Archived
	Status *EntityStatus `json:"status,omitempty"`
	// The environment this deployment is used in
	//
	// - `DEVELOPMENT` - Development
	// - `STAGING` - Staging
	// - `PRODUCTION` - Production
	Environment    *EnvironmentEnum  `json:"environment,omitempty"`
	LastDeployedOn time.Time         `json:"last_deployed_on"`
	InputVariables []*VellumVariable `json:"input_variables,omitempty"`
	// Deprecated. The Prompt execution endpoints return a `prompt_version_id` that could be used instead.
	ActiveModelVersionIds []string `json:"active_model_version_ids,omitempty"`
	// contains filtered or unexported fields
}

func (*DeploymentRead) String 

func (d *DeploymentRead) String() string

func (*DeploymentRead) UnmarshalJSON 

func (d *DeploymentRead) UnmarshalJSON(data []byte) error

type DeploymentsListRequest added in v0.2.0 

type DeploymentsListRequest struct {
	// Number of results to return per page.
	Limit *int `json:"-"`
	// The initial index from which to return the results.
	Offset *int `json:"-"`
	// Which field to use when ordering the results.
	Ordering *string `json:"-"`
	// status
	Status *DeploymentsListRequestStatus `json:"-"`
}

type DeploymentsListRequestStatus added in v0.2.0 

type DeploymentsListRequestStatus string
const (
	DeploymentsListRequestStatusActive   DeploymentsListRequestStatus = "ACTIVE"
	DeploymentsListRequestStatusArchived DeploymentsListRequestStatus = "ARCHIVED"
)

func NewDeploymentsListRequestStatusFromString added in v0.2.0 

func NewDeploymentsListRequestStatusFromString(s string) (DeploymentsListRequestStatus, error)

func (DeploymentsListRequestStatus) Ptr added in v0.2.0 

func (d DeploymentsListRequestStatus) Ptr() *DeploymentsListRequestStatus

type DocumentDocumentToDocumentIndex 

type DocumentDocumentToDocumentIndex struct {
	// Vellum-generated ID that uniquely identifies this link.
	Id string `json:"id"`
	// Vellum-generated ID that uniquely identifies the index this document is included in.
	DocumentIndexId string `json:"document_index_id"`
	// An enum value representing where this document is along its indexing lifecycle for this index.
	//
	// - `AWAITING_PROCESSING` - Awaiting Processing
	// - `QUEUED` - Queued
	// - `INDEXING` - Indexing
	// - `INDEXED` - Indexed
	// - `FAILED` - Failed
	IndexingState *IndexingStateEnum `json:"indexing_state,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentDocumentToDocumentIndex) String 

func (d *DocumentDocumentToDocumentIndex) String() string

func (*DocumentDocumentToDocumentIndex) UnmarshalJSON 

func (d *DocumentDocumentToDocumentIndex) UnmarshalJSON(data []byte) error

type DocumentIndexChunking added in v0.6.0 

type DocumentIndexChunking struct {
	ChunkerName                   string
	ReductoChunker                *ReductoChunking
	SentenceChunker               *SentenceChunking
	TokenOverlappingWindowChunker *TokenOverlappingWindowChunking
}

func NewDocumentIndexChunkingFromReductoChunker added in v0.6.0 

func NewDocumentIndexChunkingFromReductoChunker(value *ReductoChunking) *DocumentIndexChunking

func NewDocumentIndexChunkingFromSentenceChunker added in v0.6.0 

func NewDocumentIndexChunkingFromSentenceChunker(value *SentenceChunking) *DocumentIndexChunking

func NewDocumentIndexChunkingFromTokenOverlappingWindowChunker added in v0.6.0 

func NewDocumentIndexChunkingFromTokenOverlappingWindowChunker(value *TokenOverlappingWindowChunking) *DocumentIndexChunking

func (*DocumentIndexChunking) Accept added in v0.6.0 

func (d *DocumentIndexChunking) Accept(visitor DocumentIndexChunkingVisitor) error

func (DocumentIndexChunking) MarshalJSON added in v0.6.0 

func (d DocumentIndexChunking) MarshalJSON() ([]byte, error)

func (*DocumentIndexChunking) UnmarshalJSON added in v0.6.0 

func (d *DocumentIndexChunking) UnmarshalJSON(data []byte) error

type DocumentIndexChunkingRequest added in v0.6.0 

type DocumentIndexChunkingRequest struct {
	ChunkerName                   string
	ReductoChunker                *ReductoChunkingRequest
	SentenceChunker               *SentenceChunkingRequest
	TokenOverlappingWindowChunker *TokenOverlappingWindowChunkingRequest
}

func NewDocumentIndexChunkingRequestFromReductoChunker added in v0.6.0 

func NewDocumentIndexChunkingRequestFromReductoChunker(value *ReductoChunkingRequest) *DocumentIndexChunkingRequest

func NewDocumentIndexChunkingRequestFromSentenceChunker added in v0.6.0 

func NewDocumentIndexChunkingRequestFromSentenceChunker(value *SentenceChunkingRequest) *DocumentIndexChunkingRequest

func NewDocumentIndexChunkingRequestFromTokenOverlappingWindowChunker added in v0.6.0 

func NewDocumentIndexChunkingRequestFromTokenOverlappingWindowChunker(value *TokenOverlappingWindowChunkingRequest) *DocumentIndexChunkingRequest

func (*DocumentIndexChunkingRequest) Accept added in v0.6.0 

func (d *DocumentIndexChunkingRequest) Accept(visitor DocumentIndexChunkingRequestVisitor) error

func (DocumentIndexChunkingRequest) MarshalJSON added in v0.6.0 

func (d DocumentIndexChunkingRequest) MarshalJSON() ([]byte, error)

func (*DocumentIndexChunkingRequest) UnmarshalJSON added in v0.6.0 

func (d *DocumentIndexChunkingRequest) UnmarshalJSON(data []byte) error

type DocumentIndexChunkingRequestVisitor added in v0.6.0 

type DocumentIndexChunkingRequestVisitor interface {
	VisitReductoChunker(*ReductoChunkingRequest) error
	VisitSentenceChunker(*SentenceChunkingRequest) error
	VisitTokenOverlappingWindowChunker(*TokenOverlappingWindowChunkingRequest) error
}

type DocumentIndexChunkingVisitor added in v0.6.0 

type DocumentIndexChunkingVisitor interface {
	VisitReductoChunker(*ReductoChunking) error
	VisitSentenceChunker(*SentenceChunking) error
	VisitTokenOverlappingWindowChunker(*TokenOverlappingWindowChunking) error
}

type DocumentIndexCreateRequest 

type DocumentIndexCreateRequest struct {
	// A human-readable label for the document index
	Label string `json:"label"`
	// A name that uniquely identifies this index within its workspace
	Name string `json:"name"`
	// The current status of the document index
	//
	// * `ACTIVE` - Active
	// * `ARCHIVED` - Archived
	Status *EntityStatus `json:"status,omitempty"`
	// The environment this document index is used in
	//
	// * `DEVELOPMENT` - Development
	// * `STAGING` - Staging
	// * `PRODUCTION` - Production
	Environment    *EnvironmentEnum                    `json:"environment,omitempty"`
	IndexingConfig *DocumentIndexIndexingConfigRequest `json:"indexing_config,omitempty"`
	// Optionally specify the id of a document index from which you'd like to copy and re-index its documents into this newly created index
	CopyDocumentsFromIndexId *string `json:"copy_documents_from_index_id,omitempty"`
}

type DocumentIndexIndexingConfig added in v0.6.0 

type DocumentIndexIndexingConfig struct {
	Vectorizer *IndexingConfigVectorizer `json:"vectorizer,omitempty"`
	Chunking   *DocumentIndexChunking    `json:"chunking,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentIndexIndexingConfig) String added in v0.6.0 

func (d *DocumentIndexIndexingConfig) String() string

func (*DocumentIndexIndexingConfig) UnmarshalJSON added in v0.6.0 

func (d *DocumentIndexIndexingConfig) UnmarshalJSON(data []byte) error

type DocumentIndexIndexingConfigRequest added in v0.6.0 

type DocumentIndexIndexingConfigRequest struct {
	Vectorizer *IndexingConfigVectorizerRequest `json:"vectorizer,omitempty"`
	Chunking   *DocumentIndexChunkingRequest    `json:"chunking,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentIndexIndexingConfigRequest) String added in v0.6.0 

func (d *DocumentIndexIndexingConfigRequest) String() string

func (*DocumentIndexIndexingConfigRequest) UnmarshalJSON added in v0.6.0 

func (d *DocumentIndexIndexingConfigRequest) UnmarshalJSON(data []byte) error

type DocumentIndexRead 

type DocumentIndexRead struct {
	Id      string    `json:"id"`
	Created time.Time `json:"created"`
	// A human-readable label for the document index
	Label string `json:"label"`
	// A name that uniquely identifies this index within its workspace
	Name string `json:"name"`
	// The current status of the document index
	//
	// - `ACTIVE` - Active
	// - `ARCHIVED` - Archived
	Status *EntityStatus `json:"status,omitempty"`
	// The environment this document index is used in
	//
	// - `DEVELOPMENT` - Development
	// - `STAGING` - Staging
	// - `PRODUCTION` - Production
	Environment    *EnvironmentEnum             `json:"environment,omitempty"`
	IndexingConfig *DocumentIndexIndexingConfig `json:"indexing_config,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentIndexRead) String 

func (d *DocumentIndexRead) String() string

func (*DocumentIndexRead) UnmarshalJSON 

func (d *DocumentIndexRead) UnmarshalJSON(data []byte) error

type DocumentIndexUpdateRequest added in v0.3.12 

type DocumentIndexUpdateRequest struct {
	// A human-readable label for the document index
	Label string `json:"label"`
	// The current status of the document index
	//
	// * `ACTIVE` - Active
	// * `ARCHIVED` - Archived
	Status *EntityStatus `json:"status,omitempty"`
	// The environment this document index is used in
	//
	// * `DEVELOPMENT` - Development
	// * `STAGING` - Staging
	// * `PRODUCTION` - Production
	Environment *EnvironmentEnum `json:"environment,omitempty"`
}

type DocumentIndexesListRequest added in v0.3.10 

type DocumentIndexesListRequest struct {
	// Number of results to return per page.
	Limit *int `json:"-"`
	// The initial index from which to return the results.
	Offset *int `json:"-"`
	// Which field to use when ordering the results.
	Ordering *string `json:"-"`
	// Search for document indices by name or label
	Search *string `json:"-"`
	// Filter down to only document indices that have a status matching the status specified
	//
	// - `ACTIVE` - Active
	// - `ARCHIVED` - Archived
	Status *DocumentIndexesListRequestStatus `json:"-"`
}

type DocumentIndexesListRequestStatus added in v0.3.10 

type DocumentIndexesListRequestStatus string
const (
	DocumentIndexesListRequestStatusActive   DocumentIndexesListRequestStatus = "ACTIVE"
	DocumentIndexesListRequestStatusArchived DocumentIndexesListRequestStatus = "ARCHIVED"
)

func NewDocumentIndexesListRequestStatusFromString added in v0.3.10 

func NewDocumentIndexesListRequestStatusFromString(s string) (DocumentIndexesListRequestStatus, error)

func (DocumentIndexesListRequestStatus) Ptr added in v0.3.10 

func (d DocumentIndexesListRequestStatus) Ptr() *DocumentIndexesListRequestStatus

type DocumentRead 

type DocumentRead struct {
	Id string `json:"id"`
	// The unique id of this document as it exists in the user's system.
	ExternalId     *string   `json:"external_id,omitempty"`
	LastUploadedAt time.Time `json:"last_uploaded_at"`
	// A human-readable label for the document. Defaults to the originally uploaded file's file name.
	Label string `json:"label"`
	// The current processing state of the document
	//
	// - `QUEUED` - Queued
	// - `PROCESSING` - Processing
	// - `PROCESSED` - Processed
	// - `FAILED` - Failed
	ProcessingState *ProcessingStateEnum `json:"processing_state,omitempty"`
	// The current status of the document
	//
	// - `ACTIVE` - Active
	Status                    *DocumentStatus                    `json:"status,omitempty"`
	OriginalFileUrl           *string                            `json:"original_file_url,omitempty"`
	ProcessedFileUrl          *string                            `json:"processed_file_url,omitempty"`
	DocumentToDocumentIndexes []*DocumentDocumentToDocumentIndex `json:"document_to_document_indexes,omitempty"`
	// A previously supplied JSON object containing metadata that can be filtered on when searching.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentRead) String 

func (d *DocumentRead) String() string

func (*DocumentRead) UnmarshalJSON 

func (d *DocumentRead) UnmarshalJSON(data []byte) error

type DocumentStatus 

type DocumentStatus = string

- `ACTIVE` - Active

type DocumentsListRequest 

type DocumentsListRequest struct {
	// Filter down to only those documents that are included in the specified index. You may provide either the Vellum-generated ID or the unique name of the index specified upon initial creation.
	DocumentIndexId *string `json:"-"`
	// Number of results to return per page.
	Limit *int `json:"-"`
	// The initial index from which to return the results.
	Offset *int `json:"-"`
	// Which field to use when ordering the results.
	Ordering *string `json:"-"`
}

type EnrichedNormalizedCompletion 

type EnrichedNormalizedCompletion struct {
	// The Vellum-generated ID of the completion.
	Id string `json:"id"`
	// The external ID that was originally provided along with the generation request, which uniquely identifies this generation in an external system.
	ExternalId *string `json:"external_id,omitempty"`
	// The text generated by the LLM.
	Text string `json:"text"`
	// The reason the generation finished.
	//
	// - `LENGTH` - LENGTH
	// - `STOP` - STOP
	// - `UNKNOWN` - UNKNOWN
	FinishReason *FinishReasonEnum `json:"finish_reason,omitempty"`
	// The logprobs of the completion. Only present if specified in the original request options.
	Logprobs *NormalizedLogProbs `json:"logprobs,omitempty"`
	// The ID of the model version used to generate this completion.
	ModelVersionId       string              `json:"model_version_id"`
	PromptVersionId      string              `json:"prompt_version_id"`
	Type                 *VellumVariableType `json:"type,omitempty"`
	DeploymentReleaseTag string              `json:"deployment_release_tag"`
	ModelName            string              `json:"model_name"`
	// contains filtered or unexported fields
}

func (*EnrichedNormalizedCompletion) String 

func (e *EnrichedNormalizedCompletion) String() string

func (*EnrichedNormalizedCompletion) UnmarshalJSON 

func (e *EnrichedNormalizedCompletion) UnmarshalJSON(data []byte) error

type EntityStatus added in v0.2.0 

type EntityStatus string

- `ACTIVE` - Active - `ARCHIVED` - Archived 

const (
	EntityStatusActive   EntityStatus = "ACTIVE"
	EntityStatusArchived EntityStatus = "ARCHIVED"
)

func NewEntityStatusFromString added in v0.2.0 

func NewEntityStatusFromString(s string) (EntityStatus, error)

func (EntityStatus) Ptr added in v0.2.0 

func (e EntityStatus) Ptr() *EntityStatus

type EnvironmentEnum 

type EnvironmentEnum string

- `DEVELOPMENT` - Development - `STAGING` - Staging - `PRODUCTION` - Production 

const (
	EnvironmentEnumDevelopment EnvironmentEnum = "DEVELOPMENT"
	EnvironmentEnumStaging     EnvironmentEnum = "STAGING"
	EnvironmentEnumProduction  EnvironmentEnum = "PRODUCTION"
)

func NewEnvironmentEnumFromString 

func NewEnvironmentEnumFromString(s string) (EnvironmentEnum, error)

func (EnvironmentEnum) Ptr 

func (e EnvironmentEnum) Ptr() *EnvironmentEnum

type ErrorEnum added in v0.2.1 

type ErrorEnum = string

type ErrorVariableValue 

type ErrorVariableValue struct {
	Value *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ErrorVariableValue) String 

func (e *ErrorVariableValue) String() string

func (*ErrorVariableValue) UnmarshalJSON 

func (e *ErrorVariableValue) UnmarshalJSON(data []byte) error

type ErrorVellumValue added in v0.5.2 

type ErrorVellumValue struct {
	Value *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A value representing an Error.

func (*ErrorVellumValue) String added in v0.5.2 

func (e *ErrorVellumValue) String() string

func (*ErrorVellumValue) UnmarshalJSON added in v0.5.2 

func (e *ErrorVellumValue) UnmarshalJSON(data []byte) error

type ExecutePromptApiErrorResponse 

type ExecutePromptApiErrorResponse struct {
	// Details about why the request failed.
	Detail string `json:"detail"`
	// contains filtered or unexported fields
}

func (*ExecutePromptApiErrorResponse) String 

func (e *ExecutePromptApiErrorResponse) String() string

func (*ExecutePromptApiErrorResponse) UnmarshalJSON 

func (e *ExecutePromptApiErrorResponse) UnmarshalJSON(data []byte) error

type ExecutePromptEvent 

type ExecutePromptEvent struct {
	State     string
	Initiated *InitiatedExecutePromptEvent
	Streaming *StreamingExecutePromptEvent
	Fulfilled *FulfilledExecutePromptEvent
	Rejected  *RejectedExecutePromptEvent
}

func NewExecutePromptEventFromFulfilled 

func NewExecutePromptEventFromFulfilled(value *FulfilledExecutePromptEvent) *ExecutePromptEvent

func NewExecutePromptEventFromInitiated 

func NewExecutePromptEventFromInitiated(value *InitiatedExecutePromptEvent) *ExecutePromptEvent

func NewExecutePromptEventFromRejected 

func NewExecutePromptEventFromRejected(value *RejectedExecutePromptEvent) *ExecutePromptEvent

func NewExecutePromptEventFromStreaming 

func NewExecutePromptEventFromStreaming(value *StreamingExecutePromptEvent) *ExecutePromptEvent

func (*ExecutePromptEvent) Accept 

func (e *ExecutePromptEvent) Accept(visitor ExecutePromptEventVisitor) error

func (ExecutePromptEvent) MarshalJSON 

func (e ExecutePromptEvent) MarshalJSON() ([]byte, error)

func (*ExecutePromptEvent) UnmarshalJSON 

func (e *ExecutePromptEvent) UnmarshalJSON(data []byte) error

type ExecutePromptEventVisitor 

type ExecutePromptEventVisitor interface {
	VisitInitiated(*InitiatedExecutePromptEvent) error
	VisitStreaming(*StreamingExecutePromptEvent) error
	VisitFulfilled(*FulfilledExecutePromptEvent) error
	VisitRejected(*RejectedExecutePromptEvent) error
}

type ExecutePromptRequest 

type ExecutePromptRequest struct {
	// The list of inputs defined in the Prompt's deployment with their corresponding values.
	Inputs []*PromptDeploymentInputRequest `json:"inputs,omitempty"`
	// The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name.
	PromptDeploymentId *string `json:"prompt_deployment_id,omitempty"`
	// The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
	PromptDeploymentName *string `json:"prompt_deployment_name,omitempty"`
	// Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
	ReleaseTag *string `json:"release_tag,omitempty"`
	// "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
	ExternalId *string `json:"external_id,omitempty"`
	// The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
	ExpandMeta   *PromptDeploymentExpandMetaRequestRequest `json:"expand_meta,omitempty"`
	RawOverrides *RawPromptExecutionOverridesRequest       `json:"raw_overrides,omitempty"`
	// Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models.
	ExpandRaw []string               `json:"expand_raw,omitempty"`
	Metadata  map[string]interface{} `json:"metadata,omitempty"`
}

type ExecutePromptResponse 

type ExecutePromptResponse struct {
	State     string
	Fulfilled *FulfilledExecutePromptResponse
	Rejected  *RejectedExecutePromptResponse
}

func NewExecutePromptResponseFromFulfilled 

func NewExecutePromptResponseFromFulfilled(value *FulfilledExecutePromptResponse) *ExecutePromptResponse

func NewExecutePromptResponseFromRejected 

func NewExecutePromptResponseFromRejected(value *RejectedExecutePromptResponse) *ExecutePromptResponse

func (*ExecutePromptResponse) Accept 

func (e *ExecutePromptResponse) Accept(visitor ExecutePromptResponseVisitor) error

func (ExecutePromptResponse) MarshalJSON 

func (e ExecutePromptResponse) MarshalJSON() ([]byte, error)

func (*ExecutePromptResponse) UnmarshalJSON 

func (e *ExecutePromptResponse) UnmarshalJSON(data []byte) error

type ExecutePromptResponseVisitor 

type ExecutePromptResponseVisitor interface {
	VisitFulfilled(*FulfilledExecutePromptResponse) error
	VisitRejected(*RejectedExecutePromptResponse) error
}

type ExecutePromptStreamRequest 

type ExecutePromptStreamRequest struct {
	// The list of inputs defined in the Prompt's deployment with their corresponding values.
	Inputs []*PromptDeploymentInputRequest `json:"inputs,omitempty"`
	// The ID of the Prompt Deployment. Must provide either this or prompt_deployment_name.
	PromptDeploymentId *string `json:"prompt_deployment_id,omitempty"`
	// The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
	PromptDeploymentName *string `json:"prompt_deployment_name,omitempty"`
	// Optionally specify a release tag if you want to pin to a specific release of the Prompt Deployment
	ReleaseTag *string `json:"release_tag,omitempty"`
	// "Optionally include a unique identifier for tracking purposes. Must be unique for a given prompt deployment.
	ExternalId *string `json:"external_id,omitempty"`
	// The name of the Prompt Deployment. Must provide either this or prompt_deployment_id.
	ExpandMeta   *PromptDeploymentExpandMetaRequestRequest `json:"expand_meta,omitempty"`
	RawOverrides *RawPromptExecutionOverridesRequest       `json:"raw_overrides,omitempty"`
	// Returns the raw API response data sent from the model host. Combined with `raw_overrides`, it can be used to access new features from models.
	ExpandRaw []string               `json:"expand_raw,omitempty"`
	Metadata  map[string]interface{} `json:"metadata,omitempty"`
}

type ExecuteWorkflowErrorResponse added in v0.2.1 

type ExecuteWorkflowErrorResponse struct {
	// Details about why the request failed.
	Detail string `json:"detail"`
	// contains filtered or unexported fields
}

func (*ExecuteWorkflowErrorResponse) String added in v0.2.1 

func (e *ExecuteWorkflowErrorResponse) String() string

func (*ExecuteWorkflowErrorResponse) UnmarshalJSON added in v0.2.1 

func (e *ExecuteWorkflowErrorResponse) UnmarshalJSON(data []byte) error

type ExecuteWorkflowRequest added in v0.2.1 

type ExecuteWorkflowRequest struct {
	// The list of inputs defined in the Workflow's Deployment with their corresponding values.
	Inputs []*WorkflowRequestInputRequest `json:"inputs,omitempty"`
	// The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
	WorkflowDeploymentId *string `json:"workflow_deployment_id,omitempty"`
	// The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
	WorkflowDeploymentName *string `json:"workflow_deployment_name,omitempty"`
	// Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
	ReleaseTag *string `json:"release_tag,omitempty"`
	// Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
	ExternalId *string `json:"external_id,omitempty"`
}

type ExecuteWorkflowResponse added in v0.2.1 

type ExecuteWorkflowResponse struct {
	ExecutionId string                              `json:"execution_id"`
	RunId       *string                             `json:"run_id,omitempty"`
	ExternalId  *string                             `json:"external_id,omitempty"`
	Data        *ExecuteWorkflowWorkflowResultEvent `json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecuteWorkflowResponse) String added in v0.2.1 

func (e *ExecuteWorkflowResponse) String() string

func (*ExecuteWorkflowResponse) UnmarshalJSON added in v0.2.1 

func (e *ExecuteWorkflowResponse) UnmarshalJSON(data []byte) error

type ExecuteWorkflowStreamErrorResponse 

type ExecuteWorkflowStreamErrorResponse struct {
	// Details about why the request failed.
	Detail string `json:"detail"`
	// contains filtered or unexported fields
}

func (*ExecuteWorkflowStreamErrorResponse) String 

func (e *ExecuteWorkflowStreamErrorResponse) String() string

func (*ExecuteWorkflowStreamErrorResponse) UnmarshalJSON 

func (e *ExecuteWorkflowStreamErrorResponse) UnmarshalJSON(data []byte) error

type ExecuteWorkflowStreamRequest 

type ExecuteWorkflowStreamRequest struct {
	// The list of inputs defined in the Workflow's Deployment with their corresponding values.
	Inputs []*WorkflowRequestInputRequest `json:"inputs,omitempty"`
	// The ID of the Workflow Deployment. Must provide either this or workflow_deployment_name.
	WorkflowDeploymentId *string `json:"workflow_deployment_id,omitempty"`
	// The name of the Workflow Deployment. Must provide either this or workflow_deployment_id.
	WorkflowDeploymentName *string `json:"workflow_deployment_name,omitempty"`
	// Optionally specify a release tag if you want to pin to a specific release of the Workflow Deployment
	ReleaseTag *string `json:"release_tag,omitempty"`
	// Optionally include a unique identifier for tracking purposes. Must be unique for a given workflow deployment.
	ExternalId *string `json:"external_id,omitempty"`
	// Optionally specify which events you want to receive. Defaults to only WORKFLOW events. Note that the schema of non-WORKFLOW events is unstable and should be used with caution.
	EventTypes []WorkflowExecutionEventType `json:"event_types,omitempty"`
}

type ExecuteWorkflowWorkflowResultEvent added in v0.2.1 

type ExecuteWorkflowWorkflowResultEvent struct {
	State     string
	Fulfilled *FulfilledExecuteWorkflowWorkflowResultEvent
	Rejected  *RejectedExecuteWorkflowWorkflowResultEvent
}

func NewExecuteWorkflowWorkflowResultEventFromFulfilled added in v0.2.1 

func NewExecuteWorkflowWorkflowResultEventFromFulfilled(value *FulfilledExecuteWorkflowWorkflowResultEvent) *ExecuteWorkflowWorkflowResultEvent

func NewExecuteWorkflowWorkflowResultEventFromRejected added in v0.2.1 

func NewExecuteWorkflowWorkflowResultEventFromRejected(value *RejectedExecuteWorkflowWorkflowResultEvent) *ExecuteWorkflowWorkflowResultEvent

func (*ExecuteWorkflowWorkflowResultEvent) Accept added in v0.2.1 

func (e *ExecuteWorkflowWorkflowResultEvent) Accept(visitor ExecuteWorkflowWorkflowResultEventVisitor) error

func (ExecuteWorkflowWorkflowResultEvent) MarshalJSON added in v0.2.1 

func (e ExecuteWorkflowWorkflowResultEvent) MarshalJSON() ([]byte, error)

func (*ExecuteWorkflowWorkflowResultEvent) UnmarshalJSON added in v0.2.1 

func (e *ExecuteWorkflowWorkflowResultEvent) UnmarshalJSON(data []byte) error

type ExecuteWorkflowWorkflowResultEventVisitor added in v0.2.1 

type ExecuteWorkflowWorkflowResultEventVisitor interface {
	VisitFulfilled(*FulfilledExecuteWorkflowWorkflowResultEvent) error
	VisitRejected(*RejectedExecuteWorkflowWorkflowResultEvent) error
}

type ExecutionArrayVellumValue added in v0.3.11 

type ExecutionArrayVellumValue struct {
	// The variable's uniquely identifying internal id.
	Id    string                    `json:"id"`
	Name  string                    `json:"name"`
	Value []*ArrayVariableValueItem `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecutionArrayVellumValue) String added in v0.3.11 

func (e *ExecutionArrayVellumValue) String() string

func (*ExecutionArrayVellumValue) UnmarshalJSON added in v0.3.11 

func (e *ExecutionArrayVellumValue) UnmarshalJSON(data []byte) error

type ExecutionChatHistoryVellumValue added in v0.3.11 

type ExecutionChatHistoryVellumValue struct {
	// The variable's uniquely identifying internal id.
	Id    string         `json:"id"`
	Name  string         `json:"name"`
	Value []*ChatMessage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecutionChatHistoryVellumValue) String added in v0.3.11 

func (e *ExecutionChatHistoryVellumValue) String() string

func (*ExecutionChatHistoryVellumValue) UnmarshalJSON added in v0.3.11 

func (e *ExecutionChatHistoryVellumValue) UnmarshalJSON(data []byte) error

type ExecutionErrorVellumValue added in v0.3.11 

type ExecutionErrorVellumValue struct {
	// The variable's uniquely identifying internal id.
	Id    string       `json:"id"`
	Name  string       `json:"name"`
	Value *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecutionErrorVellumValue) String added in v0.3.11 

func (e *ExecutionErrorVellumValue) String() string

func (*ExecutionErrorVellumValue) UnmarshalJSON added in v0.3.11 

func (e *ExecutionErrorVellumValue) UnmarshalJSON(data []byte) error

type ExecutionFunctionCallVellumValue added in v0.3.11 

type ExecutionFunctionCallVellumValue struct {
	// The variable's uniquely identifying internal id.
	Id    string        `json:"id"`
	Name  string        `json:"name"`
	Value *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecutionFunctionCallVellumValue) String added in v0.3.11 

func (e *ExecutionFunctionCallVellumValue) String() string

func (*ExecutionFunctionCallVellumValue) UnmarshalJSON added in v0.3.11 

func (e *ExecutionFunctionCallVellumValue) UnmarshalJSON(data []byte) error

type ExecutionJsonVellumValue added in v0.3.11 

type ExecutionJsonVellumValue struct {
	// The variable's uniquely identifying internal id.
	Id    string                 `json:"id"`
	Name  string                 `json:"name"`
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecutionJsonVellumValue) String added in v0.3.11 

func (e *ExecutionJsonVellumValue) String() string

func (*ExecutionJsonVellumValue) UnmarshalJSON added in v0.3.11 

func (e *ExecutionJsonVellumValue) UnmarshalJSON(data []byte) error

type ExecutionNumberVellumValue added in v0.3.11 

type ExecutionNumberVellumValue struct {
	// The variable's uniquely identifying internal id.
	Id    string   `json:"id"`
	Name  string   `json:"name"`
	Value *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecutionNumberVellumValue) String added in v0.3.11 

func (e *ExecutionNumberVellumValue) String() string

func (*ExecutionNumberVellumValue) UnmarshalJSON added in v0.3.11 

func (e *ExecutionNumberVellumValue) UnmarshalJSON(data []byte) error

type ExecutionSearchResultsVellumValue added in v0.3.11 

type ExecutionSearchResultsVellumValue struct {
	// The variable's uniquely identifying internal id.
	Id    string          `json:"id"`
	Name  string          `json:"name"`
	Value []*SearchResult `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecutionSearchResultsVellumValue) String added in v0.3.11 

func (e *ExecutionSearchResultsVellumValue) String() string

func (*ExecutionSearchResultsVellumValue) UnmarshalJSON added in v0.3.11 

func (e *ExecutionSearchResultsVellumValue) UnmarshalJSON(data []byte) error

type ExecutionStringVellumValue added in v0.3.11 

type ExecutionStringVellumValue struct {
	// The variable's uniquely identifying internal id.
	Id    string  `json:"id"`
	Name  string  `json:"name"`
	Value *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecutionStringVellumValue) String added in v0.3.11 

func (e *ExecutionStringVellumValue) String() string

func (*ExecutionStringVellumValue) UnmarshalJSON added in v0.3.11 

func (e *ExecutionStringVellumValue) UnmarshalJSON(data []byte) error

type ExecutionVellumValue added in v0.3.11 

type ExecutionVellumValue struct {
	Type          string
	String        *ExecutionStringVellumValue
	Number        *ExecutionNumberVellumValue
	Json          *ExecutionJsonVellumValue
	ChatHistory   *ExecutionChatHistoryVellumValue
	SearchResults *ExecutionSearchResultsVellumValue
	Error         *ExecutionErrorVellumValue
	Array         *ExecutionArrayVellumValue
	FunctionCall  *ExecutionFunctionCallVellumValue
}

func NewExecutionVellumValueFromArray added in v0.3.11 

func NewExecutionVellumValueFromArray(value *ExecutionArrayVellumValue) *ExecutionVellumValue

func NewExecutionVellumValueFromChatHistory added in v0.3.11 

func NewExecutionVellumValueFromChatHistory(value *ExecutionChatHistoryVellumValue) *ExecutionVellumValue

func NewExecutionVellumValueFromError added in v0.3.11 

func NewExecutionVellumValueFromError(value *ExecutionErrorVellumValue) *ExecutionVellumValue

func NewExecutionVellumValueFromFunctionCall added in v0.3.11 

func NewExecutionVellumValueFromFunctionCall(value *ExecutionFunctionCallVellumValue) *ExecutionVellumValue

func NewExecutionVellumValueFromJson added in v0.3.11 

func NewExecutionVellumValueFromJson(value *ExecutionJsonVellumValue) *ExecutionVellumValue

func NewExecutionVellumValueFromNumber added in v0.3.11 

func NewExecutionVellumValueFromNumber(value *ExecutionNumberVellumValue) *ExecutionVellumValue

func NewExecutionVellumValueFromSearchResults added in v0.3.11 

func NewExecutionVellumValueFromSearchResults(value *ExecutionSearchResultsVellumValue) *ExecutionVellumValue

func NewExecutionVellumValueFromString added in v0.3.11 

func NewExecutionVellumValueFromString(value *ExecutionStringVellumValue) *ExecutionVellumValue

func (*ExecutionVellumValue) Accept added in v0.3.11 

func (e *ExecutionVellumValue) Accept(visitor ExecutionVellumValueVisitor) error

func (ExecutionVellumValue) MarshalJSON added in v0.3.11 

func (e ExecutionVellumValue) MarshalJSON() ([]byte, error)

func (*ExecutionVellumValue) UnmarshalJSON added in v0.3.11 

func (e *ExecutionVellumValue) UnmarshalJSON(data []byte) error

type ExecutionVellumValueVisitor added in v0.3.11 

type ExecutionVellumValueVisitor interface {
	VisitString(*ExecutionStringVellumValue) error
	VisitNumber(*ExecutionNumberVellumValue) error
	VisitJson(*ExecutionJsonVellumValue) error
	VisitChatHistory(*ExecutionChatHistoryVellumValue) error
	VisitSearchResults(*ExecutionSearchResultsVellumValue) error
	VisitError(*ExecutionErrorVellumValue) error
	VisitArray(*ExecutionArrayVellumValue) error
	VisitFunctionCall(*ExecutionFunctionCallVellumValue) error
}

type ExternalTestCaseExecution added in v0.3.23 

type ExternalTestCaseExecution struct {
	// The output values of a callable that was executed against a Test Case outside of Vellum
	Outputs    []*NamedTestCaseVariableValue `json:"outputs,omitempty"`
	TestCaseId string                        `json:"test_case_id"`
	// contains filtered or unexported fields
}

func (*ExternalTestCaseExecution) String added in v0.3.23 

func (e *ExternalTestCaseExecution) String() string

func (*ExternalTestCaseExecution) UnmarshalJSON added in v0.3.23 

func (e *ExternalTestCaseExecution) UnmarshalJSON(data []byte) error

type ExternalTestCaseExecutionRequest added in v0.3.23 

type ExternalTestCaseExecutionRequest struct {
	// The output values of a callable that was executed against a Test Case outside of Vellum
	Outputs    []*NamedTestCaseVariableValueRequest `json:"outputs,omitempty"`
	TestCaseId string                               `json:"test_case_id"`
	// contains filtered or unexported fields
}

func (*ExternalTestCaseExecutionRequest) String added in v0.3.23 

func (e *ExternalTestCaseExecutionRequest) String() string

func (*ExternalTestCaseExecutionRequest) UnmarshalJSON added in v0.3.23 

func (e *ExternalTestCaseExecutionRequest) UnmarshalJSON(data []byte) error

type FinishReasonEnum 

type FinishReasonEnum string

- `LENGTH` - LENGTH - `STOP` - STOP - `UNKNOWN` - UNKNOWN 

const (
	FinishReasonEnumLength  FinishReasonEnum = "LENGTH"
	FinishReasonEnumStop    FinishReasonEnum = "STOP"
	FinishReasonEnumUnknown FinishReasonEnum = "UNKNOWN"
)

func NewFinishReasonEnumFromString 

func NewFinishReasonEnumFromString(s string) (FinishReasonEnum, error)

func (FinishReasonEnum) Ptr 

func (f FinishReasonEnum) Ptr() *FinishReasonEnum

type ForbiddenError 

type ForbiddenError struct {
	*core.APIError
	Body interface{}
}

func (*ForbiddenError) MarshalJSON 

func (f *ForbiddenError) MarshalJSON() ([]byte, error)

func (*ForbiddenError) UnmarshalJSON 

func (f *ForbiddenError) UnmarshalJSON(data []byte) error

func (*ForbiddenError) Unwrap 

func (f *ForbiddenError) Unwrap() error

type FulfilledEnum 

type FulfilledEnum = string

type FulfilledExecutePromptEvent 

type FulfilledExecutePromptEvent struct {
	Outputs     []*PromptOutput               `json:"outputs,omitempty"`
	ExecutionId string                        `json:"execution_id"`
	Meta        *FulfilledPromptExecutionMeta `json:"meta,omitempty"`
	// contains filtered or unexported fields
}

The final data event returned indicating that the stream has ended and all final resolved values from the model can be found.

func (*FulfilledExecutePromptEvent) String 

func (f *FulfilledExecutePromptEvent) String() string

func (*FulfilledExecutePromptEvent) UnmarshalJSON 

func (f *FulfilledExecutePromptEvent) UnmarshalJSON(data []byte) error

type FulfilledExecutePromptResponse 

type FulfilledExecutePromptResponse struct {
	Meta *PromptExecutionMeta `json:"meta,omitempty"`
	// The subset of the raw response from the model that the request opted into with `expand_raw`.
	Raw map[string]interface{} `json:"raw,omitempty"`
	// The ID of the execution.
	ExecutionId string          `json:"execution_id"`
	Outputs     []*PromptOutput `json:"outputs,omitempty"`
	// contains filtered or unexported fields
}

The successful response from the model containing all of the resolved values generated by the prompt.

func (*FulfilledExecutePromptResponse) String 

func (f *FulfilledExecutePromptResponse) String() string

func (*FulfilledExecutePromptResponse) UnmarshalJSON 

func (f *FulfilledExecutePromptResponse) UnmarshalJSON(data []byte) error

type FulfilledExecuteWorkflowWorkflowResultEvent added in v0.2.1 

type FulfilledExecuteWorkflowWorkflowResultEvent struct {
	Id      string            `json:"id"`
	Ts      time.Time         `json:"ts"`
	Outputs []*WorkflowOutput `json:"outputs,omitempty"`
	// contains filtered or unexported fields
}

The successful response from the Workflow execution containing the produced outputs.

func (*FulfilledExecuteWorkflowWorkflowResultEvent) String added in v0.2.1 

func (f *FulfilledExecuteWorkflowWorkflowResultEvent) String() string

func (*FulfilledExecuteWorkflowWorkflowResultEvent) UnmarshalJSON added in v0.2.1 

func (f *FulfilledExecuteWorkflowWorkflowResultEvent) UnmarshalJSON(data []byte) error

type FulfilledPromptExecutionMeta 

type FulfilledPromptExecutionMeta struct {
	Latency      *int              `json:"latency,omitempty"`
	FinishReason *FinishReasonEnum `json:"finish_reason,omitempty"`
	Usage        *MlModelUsage     `json:"usage,omitempty"`
	// contains filtered or unexported fields
}

The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.

func (*FulfilledPromptExecutionMeta) String 

func (f *FulfilledPromptExecutionMeta) String() string

func (*FulfilledPromptExecutionMeta) UnmarshalJSON 

func (f *FulfilledPromptExecutionMeta) UnmarshalJSON(data []byte) error

type FulfilledWorkflowNodeResultEvent added in v0.3.0 

type FulfilledWorkflowNodeResultEvent struct {
	Id                string                     `json:"id"`
	NodeId            string                     `json:"node_id"`
	NodeResultId      string                     `json:"node_result_id"`
	Ts                *time.Time                 `json:"ts,omitempty"`
	Data              *WorkflowNodeResultData    `json:"data,omitempty"`
	SourceExecutionId *string                    `json:"source_execution_id,omitempty"`
	OutputValues      []*NodeOutputCompiledValue `json:"output_values,omitempty"`
	Mocked            *bool                      `json:"mocked,omitempty"`
	// contains filtered or unexported fields
}

An event that indicates that the node has fulfilled its execution.

func (*FulfilledWorkflowNodeResultEvent) String added in v0.3.0 

func (f *FulfilledWorkflowNodeResultEvent) String() string

func (*FulfilledWorkflowNodeResultEvent) UnmarshalJSON added in v0.3.0 

func (f *FulfilledWorkflowNodeResultEvent) UnmarshalJSON(data []byte) error

type FunctionCall 

type FunctionCall struct {
	Arguments map[string]interface{} `json:"arguments,omitempty"`
	Id        *string                `json:"id,omitempty"`
	Name      string                 `json:"name"`
	State     *FulfilledEnum         `json:"state,omitempty"`
	// contains filtered or unexported fields
}

The final resolved function call value.

func (*FunctionCall) String added in v0.6.0 

func (f *FunctionCall) String() string

func (*FunctionCall) UnmarshalJSON 

func (f *FunctionCall) UnmarshalJSON(data []byte) error

type FunctionCallChatMessageContent added in v0.2.0 

type FunctionCallChatMessageContent struct {
	Value *FunctionCallChatMessageContentValue `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A function call value that is used in a chat message.

func (*FunctionCallChatMessageContent) String added in v0.2.0 

func (f *FunctionCallChatMessageContent) String() string

func (*FunctionCallChatMessageContent) UnmarshalJSON added in v0.2.0 

func (f *FunctionCallChatMessageContent) UnmarshalJSON(data []byte) error

type FunctionCallChatMessageContentRequest added in v0.2.0 

type FunctionCallChatMessageContentRequest struct {
	Value *FunctionCallChatMessageContentValueRequest `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A function call value that is used in a chat message.

func (*FunctionCallChatMessageContentRequest) String added in v0.2.0 

func (f *FunctionCallChatMessageContentRequest) String() string

func (*FunctionCallChatMessageContentRequest) UnmarshalJSON added in v0.2.0 

func (f *FunctionCallChatMessageContentRequest) UnmarshalJSON(data []byte) error

type FunctionCallChatMessageContentValue added in v0.2.0 

type FunctionCallChatMessageContentValue struct {
	Name      string                 `json:"name"`
	Arguments map[string]interface{} `json:"arguments,omitempty"`
	Id        *string                `json:"id,omitempty"`
	// contains filtered or unexported fields
}

The final resolved function call value.

func (*FunctionCallChatMessageContentValue) String added in v0.2.0 

func (f *FunctionCallChatMessageContentValue) String() string

func (*FunctionCallChatMessageContentValue) UnmarshalJSON added in v0.2.0 

func (f *FunctionCallChatMessageContentValue) UnmarshalJSON(data []byte) error

type FunctionCallChatMessageContentValueRequest added in v0.2.0 

type FunctionCallChatMessageContentValueRequest struct {
	Name      string                 `json:"name"`
	Arguments map[string]interface{} `json:"arguments,omitempty"`
	Id        *string                `json:"id,omitempty"`
	// contains filtered or unexported fields
}

The final resolved function call value.

func (*FunctionCallChatMessageContentValueRequest) String added in v0.2.0 

func (f *FunctionCallChatMessageContentValueRequest) String() string

func (*FunctionCallChatMessageContentValueRequest) UnmarshalJSON added in v0.2.0 

func (f *FunctionCallChatMessageContentValueRequest) UnmarshalJSON(data []byte) error

type FunctionCallEnum added in v0.2.0 

type FunctionCallEnum = string

type FunctionCallRequest added in v0.6.0 

type FunctionCallRequest struct {
	Arguments map[string]interface{} `json:"arguments,omitempty"`
	Id        *string                `json:"id,omitempty"`
	Name      string                 `json:"name"`
	State     *FulfilledEnum         `json:"state,omitempty"`
	// contains filtered or unexported fields
}

The final resolved function call value.

func (*FunctionCallRequest) String added in v0.6.0 

func (f *FunctionCallRequest) String() string

func (*FunctionCallRequest) UnmarshalJSON added in v0.6.0 

func (f *FunctionCallRequest) UnmarshalJSON(data []byte) error

type FunctionCallVariableValue 

type FunctionCallVariableValue struct {
	Value *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*FunctionCallVariableValue) String 

func (f *FunctionCallVariableValue) String() string

func (*FunctionCallVariableValue) UnmarshalJSON 

func (f *FunctionCallVariableValue) UnmarshalJSON(data []byte) error

type FunctionCallVellumValue added in v0.5.2 

type FunctionCallVellumValue struct {
	Value *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A value representing a Function Call.

func (*FunctionCallVellumValue) String added in v0.5.2 

func (f *FunctionCallVellumValue) String() string

func (*FunctionCallVellumValue) UnmarshalJSON added in v0.5.2 

func (f *FunctionCallVellumValue) UnmarshalJSON(data []byte) error

type GenerateBodyRequest 

type GenerateBodyRequest struct {
	// The ID of the deployment. Must provide either this or deployment_name.
	DeploymentId *string `json:"deployment_id,omitempty"`
	// The name of the deployment. Must provide either this or deployment_id.
	DeploymentName *string `json:"deployment_name,omitempty"`
	// The generation request to make. Bulk requests are no longer supported, this field must be an array of length 1.
	Requests []*GenerateRequest `json:"requests,omitempty"`
	// Additional configuration that can be used to control what's included in the response.
	Options *GenerateOptionsRequest `json:"options,omitempty"`
}

type GenerateErrorResponse 

type GenerateErrorResponse struct {
	// Details about why the request failed.
	Detail string `json:"detail"`
	// contains filtered or unexported fields
}

func (*GenerateErrorResponse) String 

func (g *GenerateErrorResponse) String() string

func (*GenerateErrorResponse) UnmarshalJSON 

func (g *GenerateErrorResponse) UnmarshalJSON(data []byte) error

type GenerateOptionsRequest 

type GenerateOptionsRequest struct {
	// Which logprobs to include, if any. Defaults to NONE.
	//
	// - `ALL` - ALL
	// - `NONE` - NONE
	Logprobs *LogprobsEnum `json:"logprobs,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateOptionsRequest) String 

func (g *GenerateOptionsRequest) String() string

func (*GenerateOptionsRequest) UnmarshalJSON 

func (g *GenerateOptionsRequest) UnmarshalJSON(data []byte) error

type GenerateRequest 

type GenerateRequest struct {
	// Key/value pairs for each template variable defined in the deployment's prompt.
	InputValues map[string]interface{} `json:"input_values,omitempty"`
	// Optionally provide a list of chat messages that'll be used in place of the special chat_history variable, if included in the prompt.
	ChatHistory []*ChatMessageRequest `json:"chat_history,omitempty"`
	// Optionally include a unique identifier for each generation, as represented outside of Vellum. Note that this should generally be a list of length one.
	ExternalIds []string `json:"external_ids,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateRequest) String 

func (g *GenerateRequest) String() string

func (*GenerateRequest) UnmarshalJSON 

func (g *GenerateRequest) UnmarshalJSON(data []byte) error

type GenerateResponse 

type GenerateResponse struct {
	// The results of each generation request.
	Results []*GenerateResult `json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateResponse) String 

func (g *GenerateResponse) String() string

func (*GenerateResponse) UnmarshalJSON 

func (g *GenerateResponse) UnmarshalJSON(data []byte) error

type GenerateResult 

type GenerateResult struct {
	// An object containing the resulting generation. This key will be absent if the LLM provider experienced an error.
	Data *GenerateResultData `json:"data,omitempty"`
	// An object containing details about the error that occurred. This key will be absent if the LLM provider did not experience an error.
	Error *GenerateResultError `json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateResult) String 

func (g *GenerateResult) String() string

func (*GenerateResult) UnmarshalJSON 

func (g *GenerateResult) UnmarshalJSON(data []byte) error

type GenerateResultData 

type GenerateResultData struct {
	// The generated completions. This will generally be a list of length one.
	Completions []*EnrichedNormalizedCompletion `json:"completions,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateResultData) String 

func (g *GenerateResultData) String() string

func (*GenerateResultData) UnmarshalJSON 

func (g *GenerateResultData) UnmarshalJSON(data []byte) error

type GenerateResultError 

type GenerateResultError struct {
	// The error message returned by the LLM provider.
	Message string `json:"message"`
	// contains filtered or unexported fields
}

func (*GenerateResultError) String 

func (g *GenerateResultError) String() string

func (*GenerateResultError) UnmarshalJSON 

func (g *GenerateResultError) UnmarshalJSON(data []byte) error

type GenerateStreamBodyRequest 

type GenerateStreamBodyRequest struct {
	// The ID of the deployment. Must provide either this or deployment_name.
	DeploymentId *string `json:"deployment_id,omitempty"`
	// The name of the deployment. Must provide either this or deployment_id.
	DeploymentName *string `json:"deployment_name,omitempty"`
	// The generation request to make. Bulk requests are no longer supported, this field must be an array of length 1.
	Requests []*GenerateRequest `json:"requests,omitempty"`
	// Additional configuration that can be used to control what's included in the response.
	Options *GenerateOptionsRequest `json:"options,omitempty"`
}

type GenerateStreamResponse 

type GenerateStreamResponse struct {
	Delta *GenerateStreamResult `json:"delta,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateStreamResponse) String 

func (g *GenerateStreamResponse) String() string

func (*GenerateStreamResponse) UnmarshalJSON 

func (g *GenerateStreamResponse) UnmarshalJSON(data []byte) error

type GenerateStreamResult 

type GenerateStreamResult struct {
	RequestIndex int                       `json:"request_index"`
	Data         *GenerateStreamResultData `json:"data,omitempty"`
	Error        *GenerateResultError      `json:"error,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateStreamResult) String 

func (g *GenerateStreamResult) String() string

func (*GenerateStreamResult) UnmarshalJSON 

func (g *GenerateStreamResult) UnmarshalJSON(data []byte) error

type GenerateStreamResultData 

type GenerateStreamResultData struct {
	CompletionIndex int                           `json:"completion_index"`
	Completion      *EnrichedNormalizedCompletion `json:"completion,omitempty"`
	// contains filtered or unexported fields
}

func (*GenerateStreamResultData) String 

func (g *GenerateStreamResultData) String() string

func (*GenerateStreamResultData) UnmarshalJSON 

func (g *GenerateStreamResultData) UnmarshalJSON(data []byte) error

type HkunlpInstructorXlEnum added in v0.6.0 

type HkunlpInstructorXlEnum = string

type HkunlpInstructorXlVectorizer added in v0.6.0 

type HkunlpInstructorXlVectorizer struct {
	Config *InstructorVectorizerConfig `json:"config,omitempty"`
	// contains filtered or unexported fields
}

Vectorizer for hkunlp/instructor-xl.

func (*HkunlpInstructorXlVectorizer) String added in v0.6.0 

func (h *HkunlpInstructorXlVectorizer) String() string

func (*HkunlpInstructorXlVectorizer) UnmarshalJSON added in v0.6.0 

func (h *HkunlpInstructorXlVectorizer) UnmarshalJSON(data []byte) error

type HkunlpInstructorXlVectorizerRequest added in v0.6.0 

type HkunlpInstructorXlVectorizerRequest struct {
	Config *InstructorVectorizerConfigRequest `json:"config,omitempty"`
	// contains filtered or unexported fields
}

Vectorizer for hkunlp/instructor-xl.

func (*HkunlpInstructorXlVectorizerRequest) String added in v0.6.0 

func (h *HkunlpInstructorXlVectorizerRequest) String() string

func (*HkunlpInstructorXlVectorizerRequest) UnmarshalJSON added in v0.6.0 

func (h *HkunlpInstructorXlVectorizerRequest) UnmarshalJSON(data []byte) error

type ImageChatMessageContent added in v0.2.0 

type ImageChatMessageContent struct {
	Value *VellumImage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

An image value that is used in a chat message.

func (*ImageChatMessageContent) String added in v0.2.0 

func (i *ImageChatMessageContent) String() string

func (*ImageChatMessageContent) UnmarshalJSON added in v0.2.0 

func (i *ImageChatMessageContent) UnmarshalJSON(data []byte) error

type ImageChatMessageContentRequest added in v0.2.0 

type ImageChatMessageContentRequest struct {
	Value *VellumImageRequest `json:"value,omitempty"`
	// contains filtered or unexported fields
}

An image value that is used in a chat message.

func (*ImageChatMessageContentRequest) String added in v0.2.0 

func (i *ImageChatMessageContentRequest) String() string

func (*ImageChatMessageContentRequest) UnmarshalJSON added in v0.2.0 

func (i *ImageChatMessageContentRequest) UnmarshalJSON(data []byte) error

type ImageEnum added in v0.2.0 

type ImageEnum = string

type ImageVariableValue added in v0.3.12 

type ImageVariableValue struct {
	Value *VellumImage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A base Vellum primitive value representing an image.

func (*ImageVariableValue) String added in v0.3.12 

func (i *ImageVariableValue) String() string

func (*ImageVariableValue) UnmarshalJSON added in v0.3.12 

func (i *ImageVariableValue) UnmarshalJSON(data []byte) error

type ImageVellumValue added in v0.6.0 

type ImageVellumValue struct {
	Value *VellumImage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A base Vellum primitive value representing an image.

func (*ImageVellumValue) String added in v0.6.0 

func (i *ImageVellumValue) String() string

func (*ImageVellumValue) UnmarshalJSON added in v0.6.0 

func (i *ImageVellumValue) UnmarshalJSON(data []byte) error

type IndexingConfigVectorizer added in v0.6.0 

type IndexingConfigVectorizer struct {
	ModelName                                 string
	TextEmbedding3Small                       *OpenAiVectorizerTextEmbedding3Small
	TextEmbedding3Large                       *OpenAiVectorizerTextEmbedding3Large
	TextEmbeddingAda002                       *OpenAiVectorizerTextEmbeddingAda002
	IntfloatMultilingualE5Large               *BasicVectorizerIntfloatMultilingualE5Large
	SentenceTransformersMultiQaMpnetBaseCosV1 *BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1
	SentenceTransformersMultiQaMpnetBaseDotV1 *BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1
	HkunlpInstructorXl                        *HkunlpInstructorXlVectorizer
}

func NewIndexingConfigVectorizerFromHkunlpInstructorXl added in v0.6.0 

func NewIndexingConfigVectorizerFromHkunlpInstructorXl(value *HkunlpInstructorXlVectorizer) *IndexingConfigVectorizer

func NewIndexingConfigVectorizerFromIntfloatMultilingualE5Large added in v0.6.0 

func NewIndexingConfigVectorizerFromIntfloatMultilingualE5Large(value *BasicVectorizerIntfloatMultilingualE5Large) *IndexingConfigVectorizer

func NewIndexingConfigVectorizerFromSentenceTransformersMultiQaMpnetBaseCosV1 added in v0.6.0 

func NewIndexingConfigVectorizerFromSentenceTransformersMultiQaMpnetBaseCosV1(value *BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1) *IndexingConfigVectorizer

func NewIndexingConfigVectorizerFromSentenceTransformersMultiQaMpnetBaseDotV1 added in v0.6.0 

func NewIndexingConfigVectorizerFromSentenceTransformersMultiQaMpnetBaseDotV1(value *BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1) *IndexingConfigVectorizer

func NewIndexingConfigVectorizerFromTextEmbedding3Large added in v0.6.0 

func NewIndexingConfigVectorizerFromTextEmbedding3Large(value *OpenAiVectorizerTextEmbedding3Large) *IndexingConfigVectorizer

func NewIndexingConfigVectorizerFromTextEmbedding3Small added in v0.6.0 

func NewIndexingConfigVectorizerFromTextEmbedding3Small(value *OpenAiVectorizerTextEmbedding3Small) *IndexingConfigVectorizer

func NewIndexingConfigVectorizerFromTextEmbeddingAda002 added in v0.6.0 

func NewIndexingConfigVectorizerFromTextEmbeddingAda002(value *OpenAiVectorizerTextEmbeddingAda002) *IndexingConfigVectorizer

func (*IndexingConfigVectorizer) Accept added in v0.6.0 

func (i *IndexingConfigVectorizer) Accept(visitor IndexingConfigVectorizerVisitor) error

func (IndexingConfigVectorizer) MarshalJSON added in v0.6.0 

func (i IndexingConfigVectorizer) MarshalJSON() ([]byte, error)

func (*IndexingConfigVectorizer) UnmarshalJSON added in v0.6.0 

func (i *IndexingConfigVectorizer) UnmarshalJSON(data []byte) error

type IndexingConfigVectorizerRequest added in v0.6.0 

type IndexingConfigVectorizerRequest struct {
	ModelName                                 string
	TextEmbedding3Small                       *OpenAiVectorizerTextEmbedding3SmallRequest
	TextEmbedding3Large                       *OpenAiVectorizerTextEmbedding3LargeRequest
	TextEmbeddingAda002                       *OpenAiVectorizerTextEmbeddingAda002Request
	IntfloatMultilingualE5Large               *BasicVectorizerIntfloatMultilingualE5LargeRequest
	SentenceTransformersMultiQaMpnetBaseCosV1 *BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request
	SentenceTransformersMultiQaMpnetBaseDotV1 *BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request
	HkunlpInstructorXl                        *HkunlpInstructorXlVectorizerRequest
}

func NewIndexingConfigVectorizerRequestFromHkunlpInstructorXl added in v0.6.0 

func NewIndexingConfigVectorizerRequestFromHkunlpInstructorXl(value *HkunlpInstructorXlVectorizerRequest) *IndexingConfigVectorizerRequest

func NewIndexingConfigVectorizerRequestFromIntfloatMultilingualE5Large added in v0.6.0 

func NewIndexingConfigVectorizerRequestFromIntfloatMultilingualE5Large(value *BasicVectorizerIntfloatMultilingualE5LargeRequest) *IndexingConfigVectorizerRequest

func NewIndexingConfigVectorizerRequestFromSentenceTransformersMultiQaMpnetBaseCosV1 added in v0.6.0 

func NewIndexingConfigVectorizerRequestFromSentenceTransformersMultiQaMpnetBaseCosV1(value *BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request) *IndexingConfigVectorizerRequest

func NewIndexingConfigVectorizerRequestFromSentenceTransformersMultiQaMpnetBaseDotV1 added in v0.6.0 

func NewIndexingConfigVectorizerRequestFromSentenceTransformersMultiQaMpnetBaseDotV1(value *BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request) *IndexingConfigVectorizerRequest

func NewIndexingConfigVectorizerRequestFromTextEmbedding3Large added in v0.6.0 

func NewIndexingConfigVectorizerRequestFromTextEmbedding3Large(value *OpenAiVectorizerTextEmbedding3LargeRequest) *IndexingConfigVectorizerRequest

func NewIndexingConfigVectorizerRequestFromTextEmbedding3Small added in v0.6.0 

func NewIndexingConfigVectorizerRequestFromTextEmbedding3Small(value *OpenAiVectorizerTextEmbedding3SmallRequest) *IndexingConfigVectorizerRequest

func NewIndexingConfigVectorizerRequestFromTextEmbeddingAda002 added in v0.6.0 

func NewIndexingConfigVectorizerRequestFromTextEmbeddingAda002(value *OpenAiVectorizerTextEmbeddingAda002Request) *IndexingConfigVectorizerRequest

func (*IndexingConfigVectorizerRequest) Accept added in v0.6.0 

func (i *IndexingConfigVectorizerRequest) Accept(visitor IndexingConfigVectorizerRequestVisitor) error

func (IndexingConfigVectorizerRequest) MarshalJSON added in v0.6.0 

func (i IndexingConfigVectorizerRequest) MarshalJSON() ([]byte, error)

func (*IndexingConfigVectorizerRequest) UnmarshalJSON added in v0.6.0 

func (i *IndexingConfigVectorizerRequest) UnmarshalJSON(data []byte) error

type IndexingConfigVectorizerRequestVisitor added in v0.6.0 

type IndexingConfigVectorizerRequestVisitor interface {
	VisitTextEmbedding3Small(*OpenAiVectorizerTextEmbedding3SmallRequest) error
	VisitTextEmbedding3Large(*OpenAiVectorizerTextEmbedding3LargeRequest) error
	VisitTextEmbeddingAda002(*OpenAiVectorizerTextEmbeddingAda002Request) error
	VisitIntfloatMultilingualE5Large(*BasicVectorizerIntfloatMultilingualE5LargeRequest) error
	VisitSentenceTransformersMultiQaMpnetBaseCosV1(*BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1Request) error
	VisitSentenceTransformersMultiQaMpnetBaseDotV1(*BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1Request) error
	VisitHkunlpInstructorXl(*HkunlpInstructorXlVectorizerRequest) error
}

type IndexingConfigVectorizerVisitor added in v0.6.0 

type IndexingConfigVectorizerVisitor interface {
	VisitTextEmbedding3Small(*OpenAiVectorizerTextEmbedding3Small) error
	VisitTextEmbedding3Large(*OpenAiVectorizerTextEmbedding3Large) error
	VisitTextEmbeddingAda002(*OpenAiVectorizerTextEmbeddingAda002) error
	VisitIntfloatMultilingualE5Large(*BasicVectorizerIntfloatMultilingualE5Large) error
	VisitSentenceTransformersMultiQaMpnetBaseCosV1(*BasicVectorizerSentenceTransformersMultiQaMpnetBaseCosV1) error
	VisitSentenceTransformersMultiQaMpnetBaseDotV1(*BasicVectorizerSentenceTransformersMultiQaMpnetBaseDotV1) error
	VisitHkunlpInstructorXl(*HkunlpInstructorXlVectorizer) error
}

type IndexingStateEnum 

type IndexingStateEnum string

- `AWAITING_PROCESSING` - Awaiting Processing - `QUEUED` - Queued - `INDEXING` - Indexing - `INDEXED` - Indexed - `FAILED` - Failed 

const (
	IndexingStateEnumAwaitingProcessing IndexingStateEnum = "AWAITING_PROCESSING"
	IndexingStateEnumQueued             IndexingStateEnum = "QUEUED"
	IndexingStateEnumIndexing           IndexingStateEnum = "INDEXING"
	IndexingStateEnumIndexed            IndexingStateEnum = "INDEXED"
	IndexingStateEnumFailed             IndexingStateEnum = "FAILED"
)

func NewIndexingStateEnumFromString 

func NewIndexingStateEnumFromString(s string) (IndexingStateEnum, error)

func (IndexingStateEnum) Ptr 

func (i IndexingStateEnum) Ptr() *IndexingStateEnum

type InitiatedEnum 

type InitiatedEnum = string

type InitiatedExecutePromptEvent 

type InitiatedExecutePromptEvent struct {
	Meta        *InitiatedPromptExecutionMeta `json:"meta,omitempty"`
	ExecutionId string                        `json:"execution_id"`
	// contains filtered or unexported fields
}

The initial data returned indicating that the response from the model has returned and begun streaming.

func (*InitiatedExecutePromptEvent) String 

func (i *InitiatedExecutePromptEvent) String() string

func (*InitiatedExecutePromptEvent) UnmarshalJSON 

func (i *InitiatedExecutePromptEvent) UnmarshalJSON(data []byte) error

type InitiatedPromptExecutionMeta 

type InitiatedPromptExecutionMeta struct {
	ModelName            *string `json:"model_name,omitempty"`
	Latency              *int    `json:"latency,omitempty"`
	DeploymentReleaseTag *string `json:"deployment_release_tag,omitempty"`
	PromptVersionId      *string `json:"prompt_version_id,omitempty"`
	// contains filtered or unexported fields
}

The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.

func (*InitiatedPromptExecutionMeta) String 

func (i *InitiatedPromptExecutionMeta) String() string

func (*InitiatedPromptExecutionMeta) UnmarshalJSON 

func (i *InitiatedPromptExecutionMeta) UnmarshalJSON(data []byte) error

type InitiatedWorkflowNodeResultEvent added in v0.3.0 

type InitiatedWorkflowNodeResultEvent struct {
	Id                string                            `json:"id"`
	NodeId            string                            `json:"node_id"`
	NodeResultId      string                            `json:"node_result_id"`
	Ts                *time.Time                        `json:"ts,omitempty"`
	Data              *WorkflowNodeResultData           `json:"data,omitempty"`
	SourceExecutionId *string                           `json:"source_execution_id,omitempty"`
	InputValues       []*NodeInputVariableCompiledValue `json:"input_values,omitempty"`
	// contains filtered or unexported fields
}

An event that indicates that the node has initiated its execution.

func (*InitiatedWorkflowNodeResultEvent) String added in v0.3.0 

func (i *InitiatedWorkflowNodeResultEvent) String() string

func (*InitiatedWorkflowNodeResultEvent) UnmarshalJSON added in v0.3.0 

func (i *InitiatedWorkflowNodeResultEvent) UnmarshalJSON(data []byte) error

type InstructorVectorizerConfig added in v0.6.0 

type InstructorVectorizerConfig struct {
	InstructionDomain           string `json:"instruction_domain"`
	InstructionQueryTextType    string `json:"instruction_query_text_type"`
	InstructionDocumentTextType string `json:"instruction_document_text_type"`
	// contains filtered or unexported fields
}

Configuration for using an Instructor vectorizer.

func (*InstructorVectorizerConfig) String added in v0.6.0 

func (i *InstructorVectorizerConfig) String() string

func (*InstructorVectorizerConfig) UnmarshalJSON added in v0.6.0 

func (i *InstructorVectorizerConfig) UnmarshalJSON(data []byte) error

type InstructorVectorizerConfigRequest added in v0.6.0 

type InstructorVectorizerConfigRequest struct {
	InstructionDomain           string `json:"instruction_domain"`
	InstructionQueryTextType    string `json:"instruction_query_text_type"`
	InstructionDocumentTextType string `json:"instruction_document_text_type"`
	// contains filtered or unexported fields
}

Configuration for using an Instructor vectorizer.

func (*InstructorVectorizerConfigRequest) String added in v0.6.0 

func (i *InstructorVectorizerConfigRequest) String() string

func (*InstructorVectorizerConfigRequest) UnmarshalJSON added in v0.6.0 

func (i *InstructorVectorizerConfigRequest) UnmarshalJSON(data []byte) error

type InternalServerError 

type InternalServerError struct {
	*core.APIError
	Body interface{}
}

func (*InternalServerError) MarshalJSON 

func (i *InternalServerError) MarshalJSON() ([]byte, error)

func (*InternalServerError) UnmarshalJSON 

func (i *InternalServerError) UnmarshalJSON(data []byte) error

func (*InternalServerError) Unwrap 

func (i *InternalServerError) Unwrap() error

type IntfloatMultilingualE5LargeEnum added in v0.6.0 

type IntfloatMultilingualE5LargeEnum = string

type JsonEnum added in v0.2.1 

type JsonEnum = string

type JsonInputRequest 

type JsonInputRequest struct {
	// The variable's name, as defined in the deployment.
	Name  string                 `json:"name"`
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A user input representing a JSON object

func (*JsonInputRequest) String 

func (j *JsonInputRequest) String() string

func (*JsonInputRequest) UnmarshalJSON 

func (j *JsonInputRequest) UnmarshalJSON(data []byte) error

type JsonVariableValue 

type JsonVariableValue struct {
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*JsonVariableValue) String 

func (j *JsonVariableValue) String() string

func (*JsonVariableValue) UnmarshalJSON 

func (j *JsonVariableValue) UnmarshalJSON(data []byte) error

type JsonVellumValue added in v0.5.2 

type JsonVellumValue struct {
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A value representing a JSON object.

func (*JsonVellumValue) String added in v0.5.2 

func (j *JsonVellumValue) String() string

func (*JsonVellumValue) UnmarshalJSON added in v0.5.2 

func (j *JsonVellumValue) UnmarshalJSON(data []byte) error

type ListTestSuiteTestCasesRequest added in v0.3.20 

type ListTestSuiteTestCasesRequest struct {
	// Number of results to return per page.
	Limit *int `json:"-"`
	// The initial index from which to return the results.
	Offset *int `json:"-"`
}

type LogicalOperator 

type LogicalOperator string

- `=` - 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 

const (
	// Equals
	LogicalOperatorEquals LogicalOperator = "="
	// Does not equal
	LogicalOperatorDoesNotEqual LogicalOperator = "!="
	// Less than
	LogicalOperatorLessThan LogicalOperator = "<"
	// Greater than
	LogicalOperatorGreaterThan LogicalOperator = ">"
	// Less than or equal to
	LogicalOperatorLessThanOrEqualTo LogicalOperator = "<="
	// Greater than or equal to
	LogicalOperatorGreaterThanOrEqualTo LogicalOperator = ">="
	// Contains
	LogicalOperatorContains LogicalOperator = "contains"
	// Begins with
	LogicalOperatorBeginsWith LogicalOperator = "beginsWith"
	// Ends with
	LogicalOperatorEndsWith LogicalOperator = "endsWith"
	// Does not contain
	LogicalOperatorDoesNotContain LogicalOperator = "doesNotContain"
	// Does not begin with
	LogicalOperatorDoesNotBeginWith LogicalOperator = "doesNotBeginWith"
	// Does not end with
	LogicalOperatorDoesNotEndWith LogicalOperator = "doesNotEndWith"
	// Null
	LogicalOperatorNull LogicalOperator = "null"
	// Not null
	LogicalOperatorNotNull LogicalOperator = "notNull"
	// In
	LogicalOperatorIn LogicalOperator = "in"
	// Not in
	LogicalOperatorNotIn LogicalOperator = "notIn"
	// Between
	LogicalOperatorBetween LogicalOperator = "between"
	// Not between
	LogicalOperatorNotBetween LogicalOperator = "notBetween"
)

func NewLogicalOperatorFromString 

func NewLogicalOperatorFromString(s string) (LogicalOperator, error)

func (LogicalOperator) Ptr 

func (l LogicalOperator) Ptr() *LogicalOperator

type LogprobsEnum 

type LogprobsEnum string

- `ALL` - ALL - `NONE` - NONE 

const (
	LogprobsEnumAll  LogprobsEnum = "ALL"
	LogprobsEnumNone LogprobsEnum = "NONE"
)

func NewLogprobsEnumFromString 

func NewLogprobsEnumFromString(s string) (LogprobsEnum, error)

func (LogprobsEnum) Ptr 

func (l LogprobsEnum) Ptr() *LogprobsEnum

type MergeEnum added in v0.6.1 

type MergeEnum = string

type MergeNodeResult added in v0.6.1 

type MergeNodeResult struct {
	// contains filtered or unexported fields
}

A Node Result Event emitted from a Merge Node.

func (*MergeNodeResult) String added in v0.6.1 

func (m *MergeNodeResult) String() string

func (*MergeNodeResult) UnmarshalJSON added in v0.6.1 

func (m *MergeNodeResult) UnmarshalJSON(data []byte) error

type MetadataFilterConfigRequest 

type MetadataFilterConfigRequest struct {
	Combinator *MetadataFilterRuleCombinator `json:"combinator,omitempty"`
	Negated    *bool                         `json:"negated,omitempty"`
	Rules      []*MetadataFilterRuleRequest  `json:"rules,omitempty"`
	Field      *string                       `json:"field,omitempty"`
	Operator   *LogicalOperator              `json:"operator,omitempty"`
	Value      *string                       `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*MetadataFilterConfigRequest) String 

func (m *MetadataFilterConfigRequest) String() string

func (*MetadataFilterConfigRequest) UnmarshalJSON 

func (m *MetadataFilterConfigRequest) UnmarshalJSON(data []byte) error

type MetadataFilterRuleCombinator 

type MetadataFilterRuleCombinator string

- `and` - AND - `or` - OR 

const (
	MetadataFilterRuleCombinatorAnd MetadataFilterRuleCombinator = "and"
	MetadataFilterRuleCombinatorOr  MetadataFilterRuleCombinator = "or"
)

func NewMetadataFilterRuleCombinatorFromString 

func NewMetadataFilterRuleCombinatorFromString(s string) (MetadataFilterRuleCombinator, error)

func (MetadataFilterRuleCombinator) Ptr 

func (m MetadataFilterRuleCombinator) Ptr() *MetadataFilterRuleCombinator

type MetadataFilterRuleRequest 

type MetadataFilterRuleRequest struct {
	Combinator *MetadataFilterRuleCombinator `json:"combinator,omitempty"`
	Negated    *bool                         `json:"negated,omitempty"`
	Rules      []*MetadataFilterRuleRequest  `json:"rules,omitempty"`
	Field      *string                       `json:"field,omitempty"`
	Operator   *LogicalOperator              `json:"operator,omitempty"`
	Value      *string                       `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*MetadataFilterRuleRequest) String 

func (m *MetadataFilterRuleRequest) String() string

func (*MetadataFilterRuleRequest) UnmarshalJSON 

func (m *MetadataFilterRuleRequest) UnmarshalJSON(data []byte) error

type MetricEnum added in v0.6.0 

type MetricEnum = string

type MetricNodeResult added in v0.6.0 

type MetricNodeResult struct {
	// contains filtered or unexported fields
}

A Node Result Event emitted from a Metric Node.

func (*MetricNodeResult) String added in v0.6.0 

func (m *MetricNodeResult) String() string

func (*MetricNodeResult) UnmarshalJSON added in v0.6.0 

func (m *MetricNodeResult) UnmarshalJSON(data []byte) error

type MlModelUsage added in v0.3.21 

type MlModelUsage struct {
	OutputTokenCount *int `json:"output_token_count,omitempty"`
	InputTokenCount  *int `json:"input_token_count,omitempty"`
	InputCharCount   *int `json:"input_char_count,omitempty"`
	OutputCharCount  *int `json:"output_char_count,omitempty"`
	ComputeNanos     *int `json:"compute_nanos,omitempty"`
	// contains filtered or unexported fields
}

func (*MlModelUsage) String added in v0.3.21 

func (m *MlModelUsage) String() string

func (*MlModelUsage) UnmarshalJSON added in v0.3.21 

func (m *MlModelUsage) UnmarshalJSON(data []byte) error

type NamedScenarioInputChatHistoryVariableValueRequest added in v0.4.0 

type NamedScenarioInputChatHistoryVariableValueRequest struct {
	Value []*ChatMessageRequest `json:"value,omitempty"`
	Name  string                `json:"name"`
	// contains filtered or unexported fields
}

Named Prompt Sandbox Scenario input value that is of type CHAT_HISTORY

func (*NamedScenarioInputChatHistoryVariableValueRequest) String added in v0.4.0 

func (n *NamedScenarioInputChatHistoryVariableValueRequest) String() string

func (*NamedScenarioInputChatHistoryVariableValueRequest) UnmarshalJSON added in v0.4.0 

func (n *NamedScenarioInputChatHistoryVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedScenarioInputRequest added in v0.4.0 

type NamedScenarioInputRequest struct {
	Type        string
	String      *NamedScenarioInputStringVariableValueRequest
	ChatHistory *NamedScenarioInputChatHistoryVariableValueRequest
}

func NewNamedScenarioInputRequestFromChatHistory added in v0.4.0 

func NewNamedScenarioInputRequestFromChatHistory(value *NamedScenarioInputChatHistoryVariableValueRequest) *NamedScenarioInputRequest

func NewNamedScenarioInputRequestFromString added in v0.4.0 

func NewNamedScenarioInputRequestFromString(value *NamedScenarioInputStringVariableValueRequest) *NamedScenarioInputRequest

func (*NamedScenarioInputRequest) Accept added in v0.4.0 

func (n *NamedScenarioInputRequest) Accept(visitor NamedScenarioInputRequestVisitor) error

func (NamedScenarioInputRequest) MarshalJSON added in v0.4.0 

func (n NamedScenarioInputRequest) MarshalJSON() ([]byte, error)

func (*NamedScenarioInputRequest) UnmarshalJSON added in v0.4.0 

func (n *NamedScenarioInputRequest) UnmarshalJSON(data []byte) error

type NamedScenarioInputRequestVisitor added in v0.4.0 

type NamedScenarioInputRequestVisitor interface {
	VisitString(*NamedScenarioInputStringVariableValueRequest) error
	VisitChatHistory(*NamedScenarioInputChatHistoryVariableValueRequest) error
}

type NamedScenarioInputStringVariableValueRequest added in v0.4.0 

type NamedScenarioInputStringVariableValueRequest struct {
	Value *string `json:"value,omitempty"`
	Name  string  `json:"name"`
	// contains filtered or unexported fields
}

Named Prompt Sandbox Scenario input value that is of type STRING

func (*NamedScenarioInputStringVariableValueRequest) String added in v0.4.0 

func (n *NamedScenarioInputStringVariableValueRequest) String() string

func (*NamedScenarioInputStringVariableValueRequest) UnmarshalJSON added in v0.4.0 

func (n *NamedScenarioInputStringVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedTestCaseChatHistoryVariableValue added in v0.3.23 

type NamedTestCaseChatHistoryVariableValue struct {
	Value []*ChatMessage `json:"value,omitempty"`
	Name  string         `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type CHAT_HISTORY

func (*NamedTestCaseChatHistoryVariableValue) String added in v0.3.23 

func (n *NamedTestCaseChatHistoryVariableValue) String() string

func (*NamedTestCaseChatHistoryVariableValue) UnmarshalJSON added in v0.3.23 

func (n *NamedTestCaseChatHistoryVariableValue) UnmarshalJSON(data []byte) error

type NamedTestCaseChatHistoryVariableValueRequest 

type NamedTestCaseChatHistoryVariableValueRequest struct {
	Value []*ChatMessageRequest `json:"value,omitempty"`
	Name  string                `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type CHAT_HISTORY

func (*NamedTestCaseChatHistoryVariableValueRequest) String 

func (n *NamedTestCaseChatHistoryVariableValueRequest) String() string

func (*NamedTestCaseChatHistoryVariableValueRequest) UnmarshalJSON 

func (n *NamedTestCaseChatHistoryVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedTestCaseErrorVariableValue added in v0.3.23 

type NamedTestCaseErrorVariableValue struct {
	Value *VellumError `json:"value,omitempty"`
	Name  string       `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type ERROR

func (*NamedTestCaseErrorVariableValue) String added in v0.3.23 

func (n *NamedTestCaseErrorVariableValue) String() string

func (*NamedTestCaseErrorVariableValue) UnmarshalJSON added in v0.3.23 

func (n *NamedTestCaseErrorVariableValue) UnmarshalJSON(data []byte) error

type NamedTestCaseErrorVariableValueRequest 

type NamedTestCaseErrorVariableValueRequest struct {
	Value *VellumErrorRequest `json:"value,omitempty"`
	Name  string              `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type ERROR

func (*NamedTestCaseErrorVariableValueRequest) String 

func (n *NamedTestCaseErrorVariableValueRequest) String() string

func (*NamedTestCaseErrorVariableValueRequest) UnmarshalJSON 

func (n *NamedTestCaseErrorVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedTestCaseFunctionCallVariableValue added in v0.4.0 

type NamedTestCaseFunctionCallVariableValue struct {
	Value *FunctionCall `json:"value,omitempty"`
	Name  string        `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type FUNCTION_CALL

func (*NamedTestCaseFunctionCallVariableValue) String added in v0.4.0 

func (n *NamedTestCaseFunctionCallVariableValue) String() string

func (*NamedTestCaseFunctionCallVariableValue) UnmarshalJSON added in v0.4.0 

func (n *NamedTestCaseFunctionCallVariableValue) UnmarshalJSON(data []byte) error

type NamedTestCaseFunctionCallVariableValueRequest added in v0.4.0 

type NamedTestCaseFunctionCallVariableValueRequest struct {
	Value *FunctionCallRequest `json:"value,omitempty"`
	Name  string               `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type FUNCTION_CALL

func (*NamedTestCaseFunctionCallVariableValueRequest) String added in v0.4.0 

func (n *NamedTestCaseFunctionCallVariableValueRequest) String() string

func (*NamedTestCaseFunctionCallVariableValueRequest) UnmarshalJSON added in v0.4.0 

func (n *NamedTestCaseFunctionCallVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedTestCaseJsonVariableValue added in v0.3.23 

type NamedTestCaseJsonVariableValue struct {
	Value map[string]interface{} `json:"value,omitempty"`
	Name  string                 `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type JSON

func (*NamedTestCaseJsonVariableValue) String added in v0.3.23 

func (n *NamedTestCaseJsonVariableValue) String() string

func (*NamedTestCaseJsonVariableValue) UnmarshalJSON added in v0.3.23 

func (n *NamedTestCaseJsonVariableValue) UnmarshalJSON(data []byte) error

type NamedTestCaseJsonVariableValueRequest 

type NamedTestCaseJsonVariableValueRequest struct {
	Value map[string]interface{} `json:"value,omitempty"`
	Name  string                 `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type JSON

func (*NamedTestCaseJsonVariableValueRequest) String 

func (n *NamedTestCaseJsonVariableValueRequest) String() string

func (*NamedTestCaseJsonVariableValueRequest) UnmarshalJSON 

func (n *NamedTestCaseJsonVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedTestCaseNumberVariableValue added in v0.3.23 

type NamedTestCaseNumberVariableValue struct {
	Value *float64 `json:"value,omitempty"`
	Name  string   `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type NUMBER

func (*NamedTestCaseNumberVariableValue) String added in v0.3.23 

func (n *NamedTestCaseNumberVariableValue) String() string

func (*NamedTestCaseNumberVariableValue) UnmarshalJSON added in v0.3.23 

func (n *NamedTestCaseNumberVariableValue) UnmarshalJSON(data []byte) error

type NamedTestCaseNumberVariableValueRequest 

type NamedTestCaseNumberVariableValueRequest struct {
	Value *float64 `json:"value,omitempty"`
	Name  string   `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type NUMBER

func (*NamedTestCaseNumberVariableValueRequest) String 

func (n *NamedTestCaseNumberVariableValueRequest) String() string

func (*NamedTestCaseNumberVariableValueRequest) UnmarshalJSON 

func (n *NamedTestCaseNumberVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedTestCaseSearchResultsVariableValue added in v0.3.23 

type NamedTestCaseSearchResultsVariableValue struct {
	Value []*SearchResult `json:"value,omitempty"`
	Name  string          `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type SEARCH_RESULTS

func (*NamedTestCaseSearchResultsVariableValue) String added in v0.3.23 

func (n *NamedTestCaseSearchResultsVariableValue) String() string

func (*NamedTestCaseSearchResultsVariableValue) UnmarshalJSON added in v0.3.23 

func (n *NamedTestCaseSearchResultsVariableValue) UnmarshalJSON(data []byte) error

type NamedTestCaseSearchResultsVariableValueRequest 

type NamedTestCaseSearchResultsVariableValueRequest struct {
	Value []*SearchResultRequest `json:"value,omitempty"`
	Name  string                 `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type SEARCH_RESULTS

func (*NamedTestCaseSearchResultsVariableValueRequest) String 

func (n *NamedTestCaseSearchResultsVariableValueRequest) String() string

func (*NamedTestCaseSearchResultsVariableValueRequest) UnmarshalJSON 

func (n *NamedTestCaseSearchResultsVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedTestCaseStringVariableValue added in v0.3.23 

type NamedTestCaseStringVariableValue struct {
	Value *string `json:"value,omitempty"`
	Name  string  `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type STRING

func (*NamedTestCaseStringVariableValue) String added in v0.3.23 

func (n *NamedTestCaseStringVariableValue) String() string

func (*NamedTestCaseStringVariableValue) UnmarshalJSON added in v0.3.23 

func (n *NamedTestCaseStringVariableValue) UnmarshalJSON(data []byte) error

type NamedTestCaseStringVariableValueRequest 

type NamedTestCaseStringVariableValueRequest struct {
	Value *string `json:"value,omitempty"`
	Name  string  `json:"name"`
	// contains filtered or unexported fields
}

Named Test Case value that is of type STRING

func (*NamedTestCaseStringVariableValueRequest) String 

func (n *NamedTestCaseStringVariableValueRequest) String() string

func (*NamedTestCaseStringVariableValueRequest) UnmarshalJSON 

func (n *NamedTestCaseStringVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedTestCaseVariableValue added in v0.3.23 

type NamedTestCaseVariableValue struct {
	Type          string
	String        *NamedTestCaseStringVariableValue
	Number        *NamedTestCaseNumberVariableValue
	Json          *NamedTestCaseJsonVariableValue
	ChatHistory   *NamedTestCaseChatHistoryVariableValue
	SearchResults *NamedTestCaseSearchResultsVariableValue
	Error         *NamedTestCaseErrorVariableValue
	FunctionCall  *NamedTestCaseFunctionCallVariableValue
}

func NewNamedTestCaseVariableValueFromChatHistory added in v0.3.23 

func NewNamedTestCaseVariableValueFromChatHistory(value *NamedTestCaseChatHistoryVariableValue) *NamedTestCaseVariableValue

func NewNamedTestCaseVariableValueFromError added in v0.3.23 

func NewNamedTestCaseVariableValueFromError(value *NamedTestCaseErrorVariableValue) *NamedTestCaseVariableValue

func NewNamedTestCaseVariableValueFromFunctionCall added in v0.4.0 

func NewNamedTestCaseVariableValueFromFunctionCall(value *NamedTestCaseFunctionCallVariableValue) *NamedTestCaseVariableValue

func NewNamedTestCaseVariableValueFromJson added in v0.3.23 

func NewNamedTestCaseVariableValueFromJson(value *NamedTestCaseJsonVariableValue) *NamedTestCaseVariableValue

func NewNamedTestCaseVariableValueFromNumber added in v0.3.23 

func NewNamedTestCaseVariableValueFromNumber(value *NamedTestCaseNumberVariableValue) *NamedTestCaseVariableValue

func NewNamedTestCaseVariableValueFromSearchResults added in v0.3.23 

func NewNamedTestCaseVariableValueFromSearchResults(value *NamedTestCaseSearchResultsVariableValue) *NamedTestCaseVariableValue

func NewNamedTestCaseVariableValueFromString added in v0.3.23 

func NewNamedTestCaseVariableValueFromString(value *NamedTestCaseStringVariableValue) *NamedTestCaseVariableValue

func (*NamedTestCaseVariableValue) Accept added in v0.3.23 

func (n *NamedTestCaseVariableValue) Accept(visitor NamedTestCaseVariableValueVisitor) error

func (NamedTestCaseVariableValue) MarshalJSON added in v0.3.23 

func (n NamedTestCaseVariableValue) MarshalJSON() ([]byte, error)

func (*NamedTestCaseVariableValue) UnmarshalJSON added in v0.3.23 

func (n *NamedTestCaseVariableValue) UnmarshalJSON(data []byte) error

type NamedTestCaseVariableValueRequest 

type NamedTestCaseVariableValueRequest struct {
	Type          string
	String        *NamedTestCaseStringVariableValueRequest
	Number        *NamedTestCaseNumberVariableValueRequest
	Json          *NamedTestCaseJsonVariableValueRequest
	ChatHistory   *NamedTestCaseChatHistoryVariableValueRequest
	SearchResults *NamedTestCaseSearchResultsVariableValueRequest
	Error         *NamedTestCaseErrorVariableValueRequest
	FunctionCall  *NamedTestCaseFunctionCallVariableValueRequest
}

func NewNamedTestCaseVariableValueRequestFromChatHistory 

func NewNamedTestCaseVariableValueRequestFromChatHistory(value *NamedTestCaseChatHistoryVariableValueRequest) *NamedTestCaseVariableValueRequest

func NewNamedTestCaseVariableValueRequestFromError 

func NewNamedTestCaseVariableValueRequestFromError(value *NamedTestCaseErrorVariableValueRequest) *NamedTestCaseVariableValueRequest

func NewNamedTestCaseVariableValueRequestFromFunctionCall added in v0.4.0 

func NewNamedTestCaseVariableValueRequestFromFunctionCall(value *NamedTestCaseFunctionCallVariableValueRequest) *NamedTestCaseVariableValueRequest

func NewNamedTestCaseVariableValueRequestFromJson 

func NewNamedTestCaseVariableValueRequestFromJson(value *NamedTestCaseJsonVariableValueRequest) *NamedTestCaseVariableValueRequest

func NewNamedTestCaseVariableValueRequestFromNumber 

func NewNamedTestCaseVariableValueRequestFromNumber(value *NamedTestCaseNumberVariableValueRequest) *NamedTestCaseVariableValueRequest

func NewNamedTestCaseVariableValueRequestFromSearchResults 

func NewNamedTestCaseVariableValueRequestFromSearchResults(value *NamedTestCaseSearchResultsVariableValueRequest) *NamedTestCaseVariableValueRequest

func NewNamedTestCaseVariableValueRequestFromString 

func NewNamedTestCaseVariableValueRequestFromString(value *NamedTestCaseStringVariableValueRequest) *NamedTestCaseVariableValueRequest

func (*NamedTestCaseVariableValueRequest) Accept 

func (n *NamedTestCaseVariableValueRequest) Accept(visitor NamedTestCaseVariableValueRequestVisitor) error

func (NamedTestCaseVariableValueRequest) MarshalJSON 

func (n NamedTestCaseVariableValueRequest) MarshalJSON() ([]byte, error)

func (*NamedTestCaseVariableValueRequest) UnmarshalJSON 

func (n *NamedTestCaseVariableValueRequest) UnmarshalJSON(data []byte) error

type NamedTestCaseVariableValueRequestVisitor 

type NamedTestCaseVariableValueRequestVisitor interface {
	VisitString(*NamedTestCaseStringVariableValueRequest) error
	VisitNumber(*NamedTestCaseNumberVariableValueRequest) error
	VisitJson(*NamedTestCaseJsonVariableValueRequest) error
	VisitChatHistory(*NamedTestCaseChatHistoryVariableValueRequest) error
	VisitSearchResults(*NamedTestCaseSearchResultsVariableValueRequest) error
	VisitError(*NamedTestCaseErrorVariableValueRequest) error
	VisitFunctionCall(*NamedTestCaseFunctionCallVariableValueRequest) error
}

type NamedTestCaseVariableValueVisitor added in v0.3.23 

type NamedTestCaseVariableValueVisitor interface {
	VisitString(*NamedTestCaseStringVariableValue) error
	VisitNumber(*NamedTestCaseNumberVariableValue) error
	VisitJson(*NamedTestCaseJsonVariableValue) error
	VisitChatHistory(*NamedTestCaseChatHistoryVariableValue) error
	VisitSearchResults(*NamedTestCaseSearchResultsVariableValue) error
	VisitError(*NamedTestCaseErrorVariableValue) error
	VisitFunctionCall(*NamedTestCaseFunctionCallVariableValue) error
}

type NodeInputCompiledArrayValue added in v0.3.8 

type NodeInputCompiledArrayValue struct {
	NodeInputId string                    `json:"node_input_id"`
	Key         string                    `json:"key"`
	Value       []*ArrayVariableValueItem `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeInputCompiledArrayValue) String added in v0.3.8 

func (n *NodeInputCompiledArrayValue) String() string

func (*NodeInputCompiledArrayValue) UnmarshalJSON added in v0.3.8 

func (n *NodeInputCompiledArrayValue) UnmarshalJSON(data []byte) error

type NodeInputCompiledChatHistoryValue 

type NodeInputCompiledChatHistoryValue struct {
	NodeInputId string         `json:"node_input_id"`
	Key         string         `json:"key"`
	Value       []*ChatMessage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeInputCompiledChatHistoryValue) String 

func (n *NodeInputCompiledChatHistoryValue) String() string

func (*NodeInputCompiledChatHistoryValue) UnmarshalJSON 

func (n *NodeInputCompiledChatHistoryValue) UnmarshalJSON(data []byte) error

type NodeInputCompiledErrorValue 

type NodeInputCompiledErrorValue struct {
	NodeInputId string       `json:"node_input_id"`
	Key         string       `json:"key"`
	Value       *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeInputCompiledErrorValue) String 

func (n *NodeInputCompiledErrorValue) String() string

func (*NodeInputCompiledErrorValue) UnmarshalJSON 

func (n *NodeInputCompiledErrorValue) UnmarshalJSON(data []byte) error

type NodeInputCompiledFunctionCall added in v0.3.15 

type NodeInputCompiledFunctionCall struct {
	NodeInputId string        `json:"node_input_id"`
	Key         string        `json:"key"`
	Value       *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeInputCompiledFunctionCall) String added in v0.3.15 

func (n *NodeInputCompiledFunctionCall) String() string

func (*NodeInputCompiledFunctionCall) UnmarshalJSON added in v0.3.15 

func (n *NodeInputCompiledFunctionCall) UnmarshalJSON(data []byte) error

type NodeInputCompiledJsonValue 

type NodeInputCompiledJsonValue struct {
	NodeInputId string                 `json:"node_input_id"`
	Key         string                 `json:"key"`
	Value       map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeInputCompiledJsonValue) String 

func (n *NodeInputCompiledJsonValue) String() string

func (*NodeInputCompiledJsonValue) UnmarshalJSON 

func (n *NodeInputCompiledJsonValue) UnmarshalJSON(data []byte) error

type NodeInputCompiledNumberValue 

type NodeInputCompiledNumberValue struct {
	NodeInputId string   `json:"node_input_id"`
	Key         string   `json:"key"`
	Value       *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeInputCompiledNumberValue) String 

func (n *NodeInputCompiledNumberValue) String() string

func (*NodeInputCompiledNumberValue) UnmarshalJSON 

func (n *NodeInputCompiledNumberValue) UnmarshalJSON(data []byte) error

type NodeInputCompiledSearchResultsValue 

type NodeInputCompiledSearchResultsValue struct {
	NodeInputId string          `json:"node_input_id"`
	Key         string          `json:"key"`
	Value       []*SearchResult `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeInputCompiledSearchResultsValue) String 

func (n *NodeInputCompiledSearchResultsValue) String() string

func (*NodeInputCompiledSearchResultsValue) UnmarshalJSON 

func (n *NodeInputCompiledSearchResultsValue) UnmarshalJSON(data []byte) error

type NodeInputCompiledStringValue 

type NodeInputCompiledStringValue struct {
	NodeInputId string  `json:"node_input_id"`
	Key         string  `json:"key"`
	Value       *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*NodeInputCompiledStringValue) String 

func (n *NodeInputCompiledStringValue) String() string

func (*NodeInputCompiledStringValue) UnmarshalJSON 

func (n *NodeInputCompiledStringValue) UnmarshalJSON(data []byte) error

type NodeInputVariableCompiledValue 

type NodeInputVariableCompiledValue struct {
	Type          string
	String        *NodeInputCompiledStringValue
	Number        *NodeInputCompiledNumberValue
	Json          *NodeInputCompiledJsonValue
	ChatHistory   *NodeInputCompiledChatHistoryValue
	SearchResults *NodeInputCompiledSearchResultsValue
	Error         *NodeInputCompiledErrorValue
	Array         *NodeInputCompiledArrayValue
	FunctionCall  *NodeInputCompiledFunctionCall
}

func NewNodeInputVariableCompiledValueFromArray added in v0.3.8 

func NewNodeInputVariableCompiledValueFromArray(value *NodeInputCompiledArrayValue) *NodeInputVariableCompiledValue

func NewNodeInputVariableCompiledValueFromChatHistory 

func NewNodeInputVariableCompiledValueFromChatHistory(value *NodeInputCompiledChatHistoryValue) *NodeInputVariableCompiledValue

func NewNodeInputVariableCompiledValueFromError 

func NewNodeInputVariableCompiledValueFromError(value *NodeInputCompiledErrorValue) *NodeInputVariableCompiledValue

func NewNodeInputVariableCompiledValueFromFunctionCall added in v0.3.15 

func NewNodeInputVariableCompiledValueFromFunctionCall(value *NodeInputCompiledFunctionCall) *NodeInputVariableCompiledValue

func NewNodeInputVariableCompiledValueFromJson 

func NewNodeInputVariableCompiledValueFromJson(value *NodeInputCompiledJsonValue) *NodeInputVariableCompiledValue

func NewNodeInputVariableCompiledValueFromNumber 

func NewNodeInputVariableCompiledValueFromNumber(value *NodeInputCompiledNumberValue) *NodeInputVariableCompiledValue

func NewNodeInputVariableCompiledValueFromSearchResults 

func NewNodeInputVariableCompiledValueFromSearchResults(value *NodeInputCompiledSearchResultsValue) *NodeInputVariableCompiledValue

func NewNodeInputVariableCompiledValueFromString 

func NewNodeInputVariableCompiledValueFromString(value *NodeInputCompiledStringValue) *NodeInputVariableCompiledValue

func (*NodeInputVariableCompiledValue) Accept 

func (n *NodeInputVariableCompiledValue) Accept(visitor NodeInputVariableCompiledValueVisitor) error

func (NodeInputVariableCompiledValue) MarshalJSON 

func (n NodeInputVariableCompiledValue) MarshalJSON() ([]byte, error)

func (*NodeInputVariableCompiledValue) UnmarshalJSON 

func (n *NodeInputVariableCompiledValue) UnmarshalJSON(data []byte) error

type NodeInputVariableCompiledValueVisitor 

type NodeInputVariableCompiledValueVisitor interface {
	VisitString(*NodeInputCompiledStringValue) error
	VisitNumber(*NodeInputCompiledNumberValue) error
	VisitJson(*NodeInputCompiledJsonValue) error
	VisitChatHistory(*NodeInputCompiledChatHistoryValue) error
	VisitSearchResults(*NodeInputCompiledSearchResultsValue) error
	VisitError(*NodeInputCompiledErrorValue) error
	VisitArray(*NodeInputCompiledArrayValue) error
	VisitFunctionCall(*NodeInputCompiledFunctionCall) error
}

type NodeOutputCompiledArrayValue added in v0.3.8 

type NodeOutputCompiledArrayValue struct {
	Value        []*ArrayVellumValueItem       `json:"value,omitempty"`
	NodeOutputId string                        `json:"node_output_id"`
	State        *WorkflowNodeResultEventState `json:"state,omitempty"`
	// contains filtered or unexported fields
}

An output returned by a node that is of type ARRAY.

func (*NodeOutputCompiledArrayValue) String added in v0.3.8 

func (n *NodeOutputCompiledArrayValue) String() string

func (*NodeOutputCompiledArrayValue) UnmarshalJSON added in v0.3.8 

func (n *NodeOutputCompiledArrayValue) UnmarshalJSON(data []byte) error

type NodeOutputCompiledChatHistoryValue added in v0.3.0 

type NodeOutputCompiledChatHistoryValue struct {
	Value        []*ChatMessage                `json:"value,omitempty"`
	NodeOutputId string                        `json:"node_output_id"`
	State        *WorkflowNodeResultEventState `json:"state,omitempty"`
	// contains filtered or unexported fields
}

An output returned by a node that is of type CHAT_HISTORY.

func (*NodeOutputCompiledChatHistoryValue) String added in v0.3.0 

func (n *NodeOutputCompiledChatHistoryValue) String() string

func (*NodeOutputCompiledChatHistoryValue) UnmarshalJSON added in v0.3.0 

func (n *NodeOutputCompiledChatHistoryValue) UnmarshalJSON(data []byte) error

type NodeOutputCompiledErrorValue added in v0.3.0 

type NodeOutputCompiledErrorValue struct {
	Value        *VellumError                  `json:"value,omitempty"`
	NodeOutputId string                        `json:"node_output_id"`
	State        *WorkflowNodeResultEventState `json:"state,omitempty"`
	// contains filtered or unexported fields
}

An output returned by a node that is of type ERROR.

func (*NodeOutputCompiledErrorValue) String added in v0.3.0 

func (n *NodeOutputCompiledErrorValue) String() string

func (*NodeOutputCompiledErrorValue) UnmarshalJSON added in v0.3.0 

func (n *NodeOutputCompiledErrorValue) UnmarshalJSON(data []byte) error

type NodeOutputCompiledFunctionCallValue added in v0.5.2 

type NodeOutputCompiledFunctionCallValue struct {
	Value        *FunctionCall                 `json:"value,omitempty"`
	NodeOutputId string                        `json:"node_output_id"`
	State        *WorkflowNodeResultEventState `json:"state,omitempty"`
	// contains filtered or unexported fields
}

An output returned by a node that is of type FUNCTION_CALL.

func (*NodeOutputCompiledFunctionCallValue) String added in v0.5.2 

func (n *NodeOutputCompiledFunctionCallValue) String() string

func (*NodeOutputCompiledFunctionCallValue) UnmarshalJSON added in v0.5.2 

func (n *NodeOutputCompiledFunctionCallValue) UnmarshalJSON(data []byte) error

type NodeOutputCompiledJsonValue added in v0.3.0 

type NodeOutputCompiledJsonValue struct {
	Value        map[string]interface{}        `json:"value,omitempty"`
	NodeOutputId string                        `json:"node_output_id"`
	State        *WorkflowNodeResultEventState `json:"state,omitempty"`
	// contains filtered or unexported fields
}

An output returned by a node that is of type JSON.

func (*NodeOutputCompiledJsonValue) String added in v0.3.0 

func (n *NodeOutputCompiledJsonValue) String() string

func (*NodeOutputCompiledJsonValue) UnmarshalJSON added in v0.3.0 

func (n *NodeOutputCompiledJsonValue) UnmarshalJSON(data []byte) error

type NodeOutputCompiledNumberValue added in v0.3.0 

type NodeOutputCompiledNumberValue struct {
	Value        *float64                      `json:"value,omitempty"`
	NodeOutputId string                        `json:"node_output_id"`
	State        *WorkflowNodeResultEventState `json:"state,omitempty"`
	// contains filtered or unexported fields
}

An output returned by a node that is of type NUMBER.

func (*NodeOutputCompiledNumberValue) String added in v0.3.0 

func (n *NodeOutputCompiledNumberValue) String() string

func (*NodeOutputCompiledNumberValue) UnmarshalJSON added in v0.3.0 

func (n *NodeOutputCompiledNumberValue) UnmarshalJSON(data []byte) error

type NodeOutputCompiledSearchResultsValue added in v0.3.0 

type NodeOutputCompiledSearchResultsValue struct {
	Value        []*SearchResult               `json:"value,omitempty"`
	NodeOutputId string                        `json:"node_output_id"`
	State        *WorkflowNodeResultEventState `json:"state,omitempty"`
	// contains filtered or unexported fields
}

An output returned by a node that is of type SEARCH_RESULTS.

func (*NodeOutputCompiledSearchResultsValue) String added in v0.3.0 

func (n *NodeOutputCompiledSearchResultsValue) String() string

func (*NodeOutputCompiledSearchResultsValue) UnmarshalJSON added in v0.3.0 

func (n *NodeOutputCompiledSearchResultsValue) UnmarshalJSON(data []byte) error

type NodeOutputCompiledStringValue added in v0.3.0 

type NodeOutputCompiledStringValue struct {
	Value        *string                       `json:"value,omitempty"`
	NodeOutputId string                        `json:"node_output_id"`
	State        *WorkflowNodeResultEventState `json:"state,omitempty"`
	// contains filtered or unexported fields
}

An output returned by a node that is of type STRING.

func (*NodeOutputCompiledStringValue) String added in v0.3.0 

func (n *NodeOutputCompiledStringValue) String() string

func (*NodeOutputCompiledStringValue) UnmarshalJSON added in v0.3.0 

func (n *NodeOutputCompiledStringValue) UnmarshalJSON(data []byte) error

type NodeOutputCompiledValue added in v0.3.0 

type NodeOutputCompiledValue struct {
	Type          string
	String        *NodeOutputCompiledStringValue
	Number        *NodeOutputCompiledNumberValue
	Json          *NodeOutputCompiledJsonValue
	ChatHistory   *NodeOutputCompiledChatHistoryValue
	SearchResults *NodeOutputCompiledSearchResultsValue
	Error         *NodeOutputCompiledErrorValue
	Array         *NodeOutputCompiledArrayValue
	FunctionCall  *NodeOutputCompiledFunctionCallValue
}

func NewNodeOutputCompiledValueFromArray added in v0.3.8 

func NewNodeOutputCompiledValueFromArray(value *NodeOutputCompiledArrayValue) *NodeOutputCompiledValue

func NewNodeOutputCompiledValueFromChatHistory added in v0.3.0 

func NewNodeOutputCompiledValueFromChatHistory(value *NodeOutputCompiledChatHistoryValue) *NodeOutputCompiledValue

func NewNodeOutputCompiledValueFromError added in v0.3.0 

func NewNodeOutputCompiledValueFromError(value *NodeOutputCompiledErrorValue) *NodeOutputCompiledValue

func NewNodeOutputCompiledValueFromFunctionCall added in v0.3.8 

func NewNodeOutputCompiledValueFromFunctionCall(value *NodeOutputCompiledFunctionCallValue) *NodeOutputCompiledValue

func NewNodeOutputCompiledValueFromJson added in v0.3.0 

func NewNodeOutputCompiledValueFromJson(value *NodeOutputCompiledJsonValue) *NodeOutputCompiledValue

func NewNodeOutputCompiledValueFromNumber added in v0.3.0 

func NewNodeOutputCompiledValueFromNumber(value *NodeOutputCompiledNumberValue) *NodeOutputCompiledValue

func NewNodeOutputCompiledValueFromSearchResults added in v0.3.0 

func NewNodeOutputCompiledValueFromSearchResults(value *NodeOutputCompiledSearchResultsValue) *NodeOutputCompiledValue

func NewNodeOutputCompiledValueFromString added in v0.3.0 

func NewNodeOutputCompiledValueFromString(value *NodeOutputCompiledStringValue) *NodeOutputCompiledValue

func (*NodeOutputCompiledValue) Accept added in v0.3.0 

func (n *NodeOutputCompiledValue) Accept(visitor NodeOutputCompiledValueVisitor) error

func (NodeOutputCompiledValue) MarshalJSON added in v0.3.0 

func (n NodeOutputCompiledValue) MarshalJSON() ([]byte, error)

func (*NodeOutputCompiledValue) UnmarshalJSON added in v0.3.0 

func (n *NodeOutputCompiledValue) UnmarshalJSON(data []byte) error

type NodeOutputCompiledValueVisitor added in v0.3.0 

type NodeOutputCompiledValueVisitor interface {
	VisitString(*NodeOutputCompiledStringValue) error
	VisitNumber(*NodeOutputCompiledNumberValue) error
	VisitJson(*NodeOutputCompiledJsonValue) error
	VisitChatHistory(*NodeOutputCompiledChatHistoryValue) error
	VisitSearchResults(*NodeOutputCompiledSearchResultsValue) error
	VisitError(*NodeOutputCompiledErrorValue) error
	VisitArray(*NodeOutputCompiledArrayValue) error
	VisitFunctionCall(*NodeOutputCompiledFunctionCallValue) error
}

type NormalizedLogProbs 

type NormalizedLogProbs struct {
	Tokens     []*NormalizedTokenLogProbs `json:"tokens,omitempty"`
	Likelihood *float64                   `json:"likelihood,omitempty"`
	// contains filtered or unexported fields
}

func (*NormalizedLogProbs) String 

func (n *NormalizedLogProbs) String() string

func (*NormalizedLogProbs) UnmarshalJSON 

func (n *NormalizedLogProbs) UnmarshalJSON(data []byte) error

type NormalizedTokenLogProbs 

type NormalizedTokenLogProbs struct {
	Token       string              `json:"token"`
	Logprob     *float64            `json:"logprob,omitempty"`
	TopLogprobs map[string]*float64 `json:"top_logprobs,omitempty"`
	TextOffset  int                 `json:"text_offset"`
	// contains filtered or unexported fields
}

func (*NormalizedTokenLogProbs) String 

func (n *NormalizedTokenLogProbs) String() string

func (*NormalizedTokenLogProbs) UnmarshalJSON 

func (n *NormalizedTokenLogProbs) UnmarshalJSON(data []byte) error

type NotFoundError 

type NotFoundError struct {
	*core.APIError
	Body interface{}
}

func (*NotFoundError) MarshalJSON 

func (n *NotFoundError) MarshalJSON() ([]byte, error)

func (*NotFoundError) UnmarshalJSON 

func (n *NotFoundError) UnmarshalJSON(data []byte) error

func (*NotFoundError) Unwrap 

func (n *NotFoundError) Unwrap() error

type NumberEnum added in v0.2.1 

type NumberEnum = string

type NumberVariableValue added in v0.2.1 

type NumberVariableValue struct {
	Value *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*NumberVariableValue) String added in v0.2.1 

func (n *NumberVariableValue) String() string

func (*NumberVariableValue) UnmarshalJSON added in v0.2.1 

func (n *NumberVariableValue) UnmarshalJSON(data []byte) error

type NumberVellumValue added in v0.6.0 

type NumberVellumValue struct {
	Value *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A value representing a number.

func (*NumberVellumValue) String added in v0.6.0 

func (n *NumberVellumValue) String() string

func (*NumberVellumValue) UnmarshalJSON added in v0.6.0 

func (n *NumberVellumValue) UnmarshalJSON(data []byte) error

type OpenAiVectorizerConfig added in v0.6.0 

type OpenAiVectorizerConfig struct {
	AddOpenaiApiKey *AddOpenaiApiKeyEnum `json:"add_openai_api_key,omitempty"`
	// contains filtered or unexported fields
}

Configuration for using an OpenAI vectorizer.

func (*OpenAiVectorizerConfig) String added in v0.6.0 

func (o *OpenAiVectorizerConfig) String() string

func (*OpenAiVectorizerConfig) UnmarshalJSON added in v0.6.0 

func (o *OpenAiVectorizerConfig) UnmarshalJSON(data []byte) error

type OpenAiVectorizerConfigRequest added in v0.6.0 

type OpenAiVectorizerConfigRequest struct {
	AddOpenaiApiKey *AddOpenaiApiKeyEnum `json:"add_openai_api_key,omitempty"`
	// contains filtered or unexported fields
}

Configuration for using an OpenAI vectorizer.

func (*OpenAiVectorizerConfigRequest) String added in v0.6.0 

func (o *OpenAiVectorizerConfigRequest) String() string

func (*OpenAiVectorizerConfigRequest) UnmarshalJSON added in v0.6.0 

func (o *OpenAiVectorizerConfigRequest) UnmarshalJSON(data []byte) error

type OpenAiVectorizerTextEmbedding3Large added in v0.6.0 

type OpenAiVectorizerTextEmbedding3Large struct {
	Config *OpenAiVectorizerConfig `json:"config,omitempty"`
	// contains filtered or unexported fields
}

OpenAI vectorizer for text-embedding-3-large.

func (*OpenAiVectorizerTextEmbedding3Large) String added in v0.6.0 

func (o *OpenAiVectorizerTextEmbedding3Large) String() string

func (*OpenAiVectorizerTextEmbedding3Large) UnmarshalJSON added in v0.6.0 

func (o *OpenAiVectorizerTextEmbedding3Large) UnmarshalJSON(data []byte) error

type OpenAiVectorizerTextEmbedding3LargeRequest added in v0.6.0 

type OpenAiVectorizerTextEmbedding3LargeRequest struct {
	Config *OpenAiVectorizerConfigRequest `json:"config,omitempty"`
	// contains filtered or unexported fields
}

OpenAI vectorizer for text-embedding-3-large.

func (*OpenAiVectorizerTextEmbedding3LargeRequest) String added in v0.6.0 

func (o *OpenAiVectorizerTextEmbedding3LargeRequest) String() string

func (*OpenAiVectorizerTextEmbedding3LargeRequest) UnmarshalJSON added in v0.6.0 

func (o *OpenAiVectorizerTextEmbedding3LargeRequest) UnmarshalJSON(data []byte) error

type OpenAiVectorizerTextEmbedding3Small added in v0.6.0 

type OpenAiVectorizerTextEmbedding3Small struct {
	Config *OpenAiVectorizerConfig `json:"config,omitempty"`
	// contains filtered or unexported fields
}

OpenAI vectorizer for text-embedding-3-small.

func (*OpenAiVectorizerTextEmbedding3Small) String added in v0.6.0 

func (o *OpenAiVectorizerTextEmbedding3Small) String() string

func (*OpenAiVectorizerTextEmbedding3Small) UnmarshalJSON added in v0.6.0 

func (o *OpenAiVectorizerTextEmbedding3Small) UnmarshalJSON(data []byte) error

type OpenAiVectorizerTextEmbedding3SmallRequest added in v0.6.0 

type OpenAiVectorizerTextEmbedding3SmallRequest struct {
	Config *OpenAiVectorizerConfigRequest `json:"config,omitempty"`
	// contains filtered or unexported fields
}

OpenAI vectorizer for text-embedding-3-small.

func (*OpenAiVectorizerTextEmbedding3SmallRequest) String added in v0.6.0 

func (o *OpenAiVectorizerTextEmbedding3SmallRequest) String() string

func (*OpenAiVectorizerTextEmbedding3SmallRequest) UnmarshalJSON added in v0.6.0 

func (o *OpenAiVectorizerTextEmbedding3SmallRequest) UnmarshalJSON(data []byte) error

type OpenAiVectorizerTextEmbeddingAda002 added in v0.6.0 

type OpenAiVectorizerTextEmbeddingAda002 struct {
	Config *OpenAiVectorizerConfig `json:"config,omitempty"`
	// contains filtered or unexported fields
}

OpenAI vectorizer for text-embedding-ada-002.

func (*OpenAiVectorizerTextEmbeddingAda002) String added in v0.6.0 

func (o *OpenAiVectorizerTextEmbeddingAda002) String() string

func (*OpenAiVectorizerTextEmbeddingAda002) UnmarshalJSON added in v0.6.0 

func (o *OpenAiVectorizerTextEmbeddingAda002) UnmarshalJSON(data []byte) error

type OpenAiVectorizerTextEmbeddingAda002Request added in v0.6.0 

type OpenAiVectorizerTextEmbeddingAda002Request struct {
	Config *OpenAiVectorizerConfigRequest `json:"config,omitempty"`
	// contains filtered or unexported fields
}

OpenAI vectorizer for text-embedding-ada-002.

func (*OpenAiVectorizerTextEmbeddingAda002Request) String added in v0.6.0 

func (o *OpenAiVectorizerTextEmbeddingAda002Request) String() string

func (*OpenAiVectorizerTextEmbeddingAda002Request) UnmarshalJSON added in v0.6.0 

func (o *OpenAiVectorizerTextEmbeddingAda002Request) UnmarshalJSON(data []byte) error

type PaginatedDocumentIndexReadList added in v0.3.10 

type PaginatedDocumentIndexReadList struct {
	Count    *int                 `json:"count,omitempty"`
	Next     *string              `json:"next,omitempty"`
	Previous *string              `json:"previous,omitempty"`
	Results  []*DocumentIndexRead `json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*PaginatedDocumentIndexReadList) String added in v0.3.10 

func (p *PaginatedDocumentIndexReadList) String() string

func (*PaginatedDocumentIndexReadList) UnmarshalJSON added in v0.3.10 

func (p *PaginatedDocumentIndexReadList) UnmarshalJSON(data []byte) error

type PaginatedSlimDeploymentReadList added in v0.2.0 

type PaginatedSlimDeploymentReadList struct {
	Count    *int                  `json:"count,omitempty"`
	Next     *string               `json:"next,omitempty"`
	Previous *string               `json:"previous,omitempty"`
	Results  []*SlimDeploymentRead `json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*PaginatedSlimDeploymentReadList) String added in v0.2.0 

func (p *PaginatedSlimDeploymentReadList) String() string

func (*PaginatedSlimDeploymentReadList) UnmarshalJSON added in v0.2.0 

func (p *PaginatedSlimDeploymentReadList) UnmarshalJSON(data []byte) error

type PaginatedSlimDocumentList 

type PaginatedSlimDocumentList struct {
	Count    *int            `json:"count,omitempty"`
	Next     *string         `json:"next,omitempty"`
	Previous *string         `json:"previous,omitempty"`
	Results  []*SlimDocument `json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*PaginatedSlimDocumentList) String 

func (p *PaginatedSlimDocumentList) String() string

func (*PaginatedSlimDocumentList) UnmarshalJSON 

func (p *PaginatedSlimDocumentList) UnmarshalJSON(data []byte) error

type PaginatedSlimWorkflowDeploymentList added in v0.2.0 

type PaginatedSlimWorkflowDeploymentList struct {
	Count    *int                      `json:"count,omitempty"`
	Next     *string                   `json:"next,omitempty"`
	Previous *string                   `json:"previous,omitempty"`
	Results  []*SlimWorkflowDeployment `json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*PaginatedSlimWorkflowDeploymentList) String added in v0.2.0 

func (p *PaginatedSlimWorkflowDeploymentList) String() string

func (*PaginatedSlimWorkflowDeploymentList) UnmarshalJSON added in v0.2.0 

func (p *PaginatedSlimWorkflowDeploymentList) UnmarshalJSON(data []byte) error

type PaginatedTestSuiteRunExecutionList added in v0.3.13 

type PaginatedTestSuiteRunExecutionList struct {
	Count    int                      `json:"count"`
	Next     *string                  `json:"next,omitempty"`
	Previous *string                  `json:"previous,omitempty"`
	Results  []*TestSuiteRunExecution `json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*PaginatedTestSuiteRunExecutionList) String added in v0.3.13 

func (p *PaginatedTestSuiteRunExecutionList) String() string

func (*PaginatedTestSuiteRunExecutionList) UnmarshalJSON added in v0.3.13 

func (p *PaginatedTestSuiteRunExecutionList) UnmarshalJSON(data []byte) error

type PaginatedTestSuiteTestCaseList added in v0.3.20 

type PaginatedTestSuiteTestCaseList struct {
	Count    int                  `json:"count"`
	Next     *string              `json:"next,omitempty"`
	Previous *string              `json:"previous,omitempty"`
	Results  []*TestSuiteTestCase `json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*PaginatedTestSuiteTestCaseList) String added in v0.3.20 

func (p *PaginatedTestSuiteTestCaseList) String() string

func (*PaginatedTestSuiteTestCaseList) UnmarshalJSON added in v0.3.20 

func (p *PaginatedTestSuiteTestCaseList) UnmarshalJSON(data []byte) error

type PatchedDocumentIndexUpdateRequest added in v0.3.12 

type PatchedDocumentIndexUpdateRequest struct {
	// A human-readable label for the document index
	Label *string `json:"label,omitempty"`
	// The current status of the document index
	//
	// * `ACTIVE` - Active
	// * `ARCHIVED` - Archived
	Status *EntityStatus `json:"status,omitempty"`
	// The environment this document index is used in
	//
	// * `DEVELOPMENT` - Development
	// * `STAGING` - Staging
	// * `PRODUCTION` - Production
	Environment *EnvironmentEnum `json:"environment,omitempty"`
}

type PatchedDocumentUpdateRequest 

type PatchedDocumentUpdateRequest struct {
	// A human-readable label for the document. Defaults to the originally uploaded file's file name.
	Label *string `json:"label,omitempty"`
	// The current status of the document
	//
	// * `ACTIVE` - Active
	Status *DocumentStatus `json:"status,omitempty"`
	// A JSON object containing any metadata associated with the document that you'd like to filter upon later.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
}

type ProcessingFailureReasonEnum 

type ProcessingFailureReasonEnum string

- `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit - `INVALID_FILE` - Invalid File 

const (
	ProcessingFailureReasonEnumExceededCharacterLimit ProcessingFailureReasonEnum = "EXCEEDED_CHARACTER_LIMIT"
	ProcessingFailureReasonEnumInvalidFile            ProcessingFailureReasonEnum = "INVALID_FILE"
)

func NewProcessingFailureReasonEnumFromString 

func NewProcessingFailureReasonEnumFromString(s string) (ProcessingFailureReasonEnum, error)

func (ProcessingFailureReasonEnum) Ptr 

func (p ProcessingFailureReasonEnum) Ptr() *ProcessingFailureReasonEnum

type ProcessingStateEnum 

type ProcessingStateEnum string

- `QUEUED` - Queued - `PROCESSING` - Processing - `PROCESSED` - Processed - `FAILED` - Failed 

const (
	ProcessingStateEnumQueued     ProcessingStateEnum = "QUEUED"
	ProcessingStateEnumProcessing ProcessingStateEnum = "PROCESSING"
	ProcessingStateEnumProcessed  ProcessingStateEnum = "PROCESSED"
	ProcessingStateEnumFailed     ProcessingStateEnum = "FAILED"
)

func NewProcessingStateEnumFromString 

func NewProcessingStateEnumFromString(s string) (ProcessingStateEnum, error)

func (ProcessingStateEnum) Ptr 

func (p ProcessingStateEnum) Ptr() *ProcessingStateEnum

type PromptDeploymentExpandMetaRequestRequest 

type PromptDeploymentExpandMetaRequestRequest struct {
	// If enabled, the response will include the model identifier representing the ML Model invoked by the Prompt Deployment.
	ModelName *bool `json:"model_name,omitempty"`
	// If enabled, the response will include the time in nanoseconds it took to execute the Prompt Deployment.
	Latency *bool `json:"latency,omitempty"`
	// If enabled, the response will include the release tag of the Prompt Deployment.
	DeploymentReleaseTag *bool `json:"deployment_release_tag,omitempty"`
	// If enabled, the response will include the ID of the Prompt Version backing the deployment.
	PromptVersionId *bool `json:"prompt_version_id,omitempty"`
	// If enabled, the response will include the reason provided by the model for why the execution finished.
	FinishReason *bool `json:"finish_reason,omitempty"`
	// If enabled, the response will include model host usage tracking. This may increase latency for some model hosts.
	Usage *bool `json:"usage,omitempty"`
	// contains filtered or unexported fields
}

func (*PromptDeploymentExpandMetaRequestRequest) String 

func (p *PromptDeploymentExpandMetaRequestRequest) String() string

func (*PromptDeploymentExpandMetaRequestRequest) UnmarshalJSON 

func (p *PromptDeploymentExpandMetaRequestRequest) UnmarshalJSON(data []byte) error

type PromptDeploymentInputRequest 

type PromptDeploymentInputRequest struct {
	Type        string
	String      *StringInputRequest
	Json        *JsonInputRequest
	ChatHistory *ChatHistoryInputRequest
}

func NewPromptDeploymentInputRequestFromChatHistory 

func NewPromptDeploymentInputRequestFromChatHistory(value *ChatHistoryInputRequest) *PromptDeploymentInputRequest

func NewPromptDeploymentInputRequestFromJson 

func NewPromptDeploymentInputRequestFromJson(value *JsonInputRequest) *PromptDeploymentInputRequest

func NewPromptDeploymentInputRequestFromString 

func NewPromptDeploymentInputRequestFromString(value *StringInputRequest) *PromptDeploymentInputRequest

func (*PromptDeploymentInputRequest) Accept 

func (p *PromptDeploymentInputRequest) Accept(visitor PromptDeploymentInputRequestVisitor) error

func (PromptDeploymentInputRequest) MarshalJSON 

func (p PromptDeploymentInputRequest) MarshalJSON() ([]byte, error)

func (*PromptDeploymentInputRequest) UnmarshalJSON 

func (p *PromptDeploymentInputRequest) UnmarshalJSON(data []byte) error

type PromptDeploymentInputRequestVisitor 

type PromptDeploymentInputRequestVisitor interface {
	VisitString(*StringInputRequest) error
	VisitJson(*JsonInputRequest) error
	VisitChatHistory(*ChatHistoryInputRequest) error
}

type PromptExecutionMeta 

type PromptExecutionMeta struct {
	Usage                *MlModelUsage     `json:"usage,omitempty"`
	ModelName            *string           `json:"model_name,omitempty"`
	Latency              *int              `json:"latency,omitempty"`
	DeploymentReleaseTag *string           `json:"deployment_release_tag,omitempty"`
	PromptVersionId      *string           `json:"prompt_version_id,omitempty"`
	FinishReason         *FinishReasonEnum `json:"finish_reason,omitempty"`
	// contains filtered or unexported fields
}

The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.

func (*PromptExecutionMeta) String 

func (p *PromptExecutionMeta) String() string

func (*PromptExecutionMeta) UnmarshalJSON 

func (p *PromptExecutionMeta) UnmarshalJSON(data []byte) error

type PromptNodeResult 

type PromptNodeResult struct {
	Data *PromptNodeResultData `json:"data,omitempty"`
	// contains filtered or unexported fields
}

A Node Result Event emitted from a Prompt Node.

func (*PromptNodeResult) String 

func (p *PromptNodeResult) String() string

func (*PromptNodeResult) UnmarshalJSON 

func (p *PromptNodeResult) UnmarshalJSON(data []byte) error

type PromptNodeResultData 

type PromptNodeResultData struct {
	OutputId      string  `json:"output_id"`
	ArrayOutputId *string `json:"array_output_id,omitempty"`
	Text          *string `json:"text,omitempty"`
	Delta         *string `json:"delta,omitempty"`
	// contains filtered or unexported fields
}

func (*PromptNodeResultData) String 

func (p *PromptNodeResultData) String() string

func (*PromptNodeResultData) UnmarshalJSON 

func (p *PromptNodeResultData) UnmarshalJSON(data []byte) error

type PromptOutput 

type PromptOutput struct {
	Type         string
	String       *StringVellumValue
	Json         *JsonVellumValue
	Error        *ErrorVellumValue
	FunctionCall *FunctionCallVellumValue
}

func NewPromptOutputFromError 

func NewPromptOutputFromError(value *ErrorVellumValue) *PromptOutput

func NewPromptOutputFromFunctionCall 

func NewPromptOutputFromFunctionCall(value *FunctionCallVellumValue) *PromptOutput

func NewPromptOutputFromJson 

func NewPromptOutputFromJson(value *JsonVellumValue) *PromptOutput

func NewPromptOutputFromString 

func NewPromptOutputFromString(value *StringVellumValue) *PromptOutput

func (*PromptOutput) Accept 

func (p *PromptOutput) Accept(visitor PromptOutputVisitor) error

func (PromptOutput) MarshalJSON 

func (p PromptOutput) MarshalJSON() ([]byte, error)

func (*PromptOutput) UnmarshalJSON 

func (p *PromptOutput) UnmarshalJSON(data []byte) error

type PromptOutputVisitor 

type PromptOutputVisitor interface {
	VisitString(*StringVellumValue) error
	VisitJson(*JsonVellumValue) error
	VisitError(*ErrorVellumValue) error
	VisitFunctionCall(*FunctionCallVellumValue) error
}

type RawPromptExecutionOverridesRequest 

type RawPromptExecutionOverridesRequest struct {
	Body map[string]interface{} `json:"body,omitempty"`
	// The raw headers to send to the model host.
	Headers map[string]*string `json:"headers,omitempty"`
	// The raw URL to send to the model host.
	Url *string `json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*RawPromptExecutionOverridesRequest) String 

func (r *RawPromptExecutionOverridesRequest) String() string

func (*RawPromptExecutionOverridesRequest) UnmarshalJSON 

func (r *RawPromptExecutionOverridesRequest) UnmarshalJSON(data []byte) error

type ReductoChunkerConfig added in v0.6.0 

type ReductoChunkerConfig struct {
	CharacterLimit *int `json:"character_limit,omitempty"`
	// contains filtered or unexported fields
}

Configuration for Reducto chunking

func (*ReductoChunkerConfig) String added in v0.6.0 

func (r *ReductoChunkerConfig) String() string

func (*ReductoChunkerConfig) UnmarshalJSON added in v0.6.0 

func (r *ReductoChunkerConfig) UnmarshalJSON(data []byte) error

type ReductoChunkerConfigRequest added in v0.6.0 

type ReductoChunkerConfigRequest struct {
	CharacterLimit *int `json:"character_limit,omitempty"`
	// contains filtered or unexported fields
}

Configuration for Reducto chunking

func (*ReductoChunkerConfigRequest) String added in v0.6.0 

func (r *ReductoChunkerConfigRequest) String() string

func (*ReductoChunkerConfigRequest) UnmarshalJSON added in v0.6.0 

func (r *ReductoChunkerConfigRequest) UnmarshalJSON(data []byte) error

type ReductoChunkerEnum added in v0.6.0 

type ReductoChunkerEnum = string

type ReductoChunking added in v0.6.0 

type ReductoChunking struct {
	ChunkerConfig *ReductoChunkerConfig `json:"chunker_config,omitempty"`
	// contains filtered or unexported fields
}

Reducto chunking

func (*ReductoChunking) String added in v0.6.0 

func (r *ReductoChunking) String() string

func (*ReductoChunking) UnmarshalJSON added in v0.6.0 

func (r *ReductoChunking) UnmarshalJSON(data []byte) error

type ReductoChunkingRequest added in v0.6.0 

type ReductoChunkingRequest struct {
	ChunkerConfig *ReductoChunkerConfigRequest `json:"chunker_config,omitempty"`
	// contains filtered or unexported fields
}

Reducto chunking

func (*ReductoChunkingRequest) String added in v0.6.0 

func (r *ReductoChunkingRequest) String() string

func (*ReductoChunkingRequest) UnmarshalJSON added in v0.6.0 

func (r *ReductoChunkingRequest) UnmarshalJSON(data []byte) error

type RejectedEnum 

type RejectedEnum = string

type RejectedExecutePromptEvent 

type RejectedExecutePromptEvent struct {
	Error       *VellumError                 `json:"error,omitempty"`
	ExecutionId string                       `json:"execution_id"`
	Meta        *RejectedPromptExecutionMeta `json:"meta,omitempty"`
	// contains filtered or unexported fields
}

The final data returned indicating an error occurred during the stream.

func (*RejectedExecutePromptEvent) String 

func (r *RejectedExecutePromptEvent) String() string

func (*RejectedExecutePromptEvent) UnmarshalJSON 

func (r *RejectedExecutePromptEvent) UnmarshalJSON(data []byte) error

type RejectedExecutePromptResponse 

type RejectedExecutePromptResponse struct {
	Meta *PromptExecutionMeta `json:"meta,omitempty"`
	// The subset of the raw response from the model that the request opted into with `expand_raw`.
	Raw map[string]interface{} `json:"raw,omitempty"`
	// The ID of the execution.
	ExecutionId string       `json:"execution_id"`
	Error       *VellumError `json:"error,omitempty"`
	// contains filtered or unexported fields
}

The unsuccessful response from the model containing an error of what went wrong.

func (*RejectedExecutePromptResponse) String 

func (r *RejectedExecutePromptResponse) String() string

func (*RejectedExecutePromptResponse) UnmarshalJSON 

func (r *RejectedExecutePromptResponse) UnmarshalJSON(data []byte) error

type RejectedExecuteWorkflowWorkflowResultEvent added in v0.2.1 

type RejectedExecuteWorkflowWorkflowResultEvent struct {
	Id    string              `json:"id"`
	Ts    time.Time           `json:"ts"`
	Error *WorkflowEventError `json:"error,omitempty"`
	// contains filtered or unexported fields
}

The unsuccessful response from the Workflow execution containing an error specifying what went wrong.

func (*RejectedExecuteWorkflowWorkflowResultEvent) String added in v0.2.1 

func (r *RejectedExecuteWorkflowWorkflowResultEvent) String() string

func (*RejectedExecuteWorkflowWorkflowResultEvent) UnmarshalJSON added in v0.2.1 

func (r *RejectedExecuteWorkflowWorkflowResultEvent) UnmarshalJSON(data []byte) error

type RejectedPromptExecutionMeta 

type RejectedPromptExecutionMeta struct {
	Latency      *int              `json:"latency,omitempty"`
	FinishReason *FinishReasonEnum `json:"finish_reason,omitempty"`
	// contains filtered or unexported fields
}

The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.

func (*RejectedPromptExecutionMeta) String 

func (r *RejectedPromptExecutionMeta) String() string

func (*RejectedPromptExecutionMeta) UnmarshalJSON 

func (r *RejectedPromptExecutionMeta) UnmarshalJSON(data []byte) error

type RejectedWorkflowNodeResultEvent added in v0.3.0 

type RejectedWorkflowNodeResultEvent struct {
	Id                string                  `json:"id"`
	NodeId            string                  `json:"node_id"`
	NodeResultId      string                  `json:"node_result_id"`
	Ts                *time.Time              `json:"ts,omitempty"`
	Data              *WorkflowNodeResultData `json:"data,omitempty"`
	SourceExecutionId *string                 `json:"source_execution_id,omitempty"`
	Error             *WorkflowEventError     `json:"error,omitempty"`
	// contains filtered or unexported fields
}

An event that indicates that the node has rejected its execution.

func (*RejectedWorkflowNodeResultEvent) String added in v0.3.0 

func (r *RejectedWorkflowNodeResultEvent) String() string

func (*RejectedWorkflowNodeResultEvent) UnmarshalJSON added in v0.3.0 

func (r *RejectedWorkflowNodeResultEvent) UnmarshalJSON(data []byte) error

type SandboxScenario 

type SandboxScenario struct {
	Label *string `json:"label,omitempty"`
	// The inputs for the scenario
	Inputs []*ScenarioInput `json:"inputs,omitempty"`
	// The id of the scenario
	Id string `json:"id"`
	// contains filtered or unexported fields
}

Sandbox Scenario

func (*SandboxScenario) String 

func (s *SandboxScenario) String() string

func (*SandboxScenario) UnmarshalJSON 

func (s *SandboxScenario) UnmarshalJSON(data []byte) error

type ScenarioInput 

type ScenarioInput struct {
	Type        string
	String      *ScenarioInputStringVariableValue
	ChatHistory *ScenarioInputChatHistoryVariableValue
}

func NewScenarioInputFromChatHistory added in v0.4.0 

func NewScenarioInputFromChatHistory(value *ScenarioInputChatHistoryVariableValue) *ScenarioInput

func NewScenarioInputFromString added in v0.4.0 

func NewScenarioInputFromString(value *ScenarioInputStringVariableValue) *ScenarioInput

func (*ScenarioInput) Accept added in v0.4.0 

func (s *ScenarioInput) Accept(visitor ScenarioInputVisitor) error

func (ScenarioInput) MarshalJSON added in v0.4.0 

func (s ScenarioInput) MarshalJSON() ([]byte, error)

func (*ScenarioInput) UnmarshalJSON 

func (s *ScenarioInput) UnmarshalJSON(data []byte) error

type ScenarioInputChatHistoryVariableValue added in v0.4.0 

type ScenarioInputChatHistoryVariableValue struct {
	Value           []*ChatMessage `json:"value,omitempty"`
	InputVariableId string         `json:"input_variable_id"`
	// contains filtered or unexported fields
}

Prompt Sandbox Scenario input value that is of type CHAT_HISTORY

func (*ScenarioInputChatHistoryVariableValue) String added in v0.4.0 

func (s *ScenarioInputChatHistoryVariableValue) String() string

func (*ScenarioInputChatHistoryVariableValue) UnmarshalJSON added in v0.4.0 

func (s *ScenarioInputChatHistoryVariableValue) UnmarshalJSON(data []byte) error

type ScenarioInputStringVariableValue added in v0.4.0 

type ScenarioInputStringVariableValue struct {
	Value           *string `json:"value,omitempty"`
	InputVariableId string  `json:"input_variable_id"`
	// contains filtered or unexported fields
}

Prompt Sandbox Scenario input value that is of type STRING

func (*ScenarioInputStringVariableValue) String added in v0.4.0 

func (s *ScenarioInputStringVariableValue) String() string

func (*ScenarioInputStringVariableValue) UnmarshalJSON added in v0.4.0 

func (s *ScenarioInputStringVariableValue) UnmarshalJSON(data []byte) error

type ScenarioInputVisitor added in v0.4.0 

type ScenarioInputVisitor interface {
	VisitString(*ScenarioInputStringVariableValue) error
	VisitChatHistory(*ScenarioInputChatHistoryVariableValue) error
}

type SearchErrorResponse 

type SearchErrorResponse struct {
	// Details about why the request failed.
	Detail string `json:"detail"`
	// contains filtered or unexported fields
}

func (*SearchErrorResponse) String 

func (s *SearchErrorResponse) String() string

func (*SearchErrorResponse) UnmarshalJSON 

func (s *SearchErrorResponse) UnmarshalJSON(data []byte) error

type SearchFiltersRequest 

type SearchFiltersRequest struct {
	// The document external IDs to filter by
	ExternalIds []string `json:"external_ids,omitempty"`
	// The metadata filters to apply to the search
	Metadata *MetadataFilterConfigRequest `json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchFiltersRequest) String 

func (s *SearchFiltersRequest) String() string

func (*SearchFiltersRequest) UnmarshalJSON 

func (s *SearchFiltersRequest) UnmarshalJSON(data []byte) error

type SearchNodeResult 

type SearchNodeResult struct {
	Data *SearchNodeResultData `json:"data,omitempty"`
	// contains filtered or unexported fields
}

A Node Result Event emitted from a Search Node.

func (*SearchNodeResult) String 

func (s *SearchNodeResult) String() string

func (*SearchNodeResult) UnmarshalJSON 

func (s *SearchNodeResult) UnmarshalJSON(data []byte) error

type SearchNodeResultData 

type SearchNodeResultData struct {
	ResultsOutputId string `json:"results_output_id"`
	// The results of the search. Each result represents a chunk that matches the search query.
	Results      []*SearchResult `json:"results,omitempty"`
	TextOutputId string          `json:"text_output_id"`
	Text         *string         `json:"text,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchNodeResultData) String 

func (s *SearchNodeResultData) String() string

func (*SearchNodeResultData) UnmarshalJSON 

func (s *SearchNodeResultData) UnmarshalJSON(data []byte) error

type SearchRequestBodyRequest 

type SearchRequestBodyRequest struct {
	// The ID of the index to search against. Must provide either this or index_name.
	IndexId *string `json:"index_id,omitempty"`
	// The name of the index to search against. Must provide either this or index_id.
	IndexName *string `json:"index_name,omitempty"`
	// The query to search for.
	Query string `json:"query"`
	// Configuration options for the search.
	Options *SearchRequestOptionsRequest `json:"options,omitempty"`
}

type SearchRequestOptionsRequest 

type SearchRequestOptionsRequest struct {
	// The maximum number of results to return.
	Limit *int `json:"limit,omitempty"`
	// The weights to use for the search. Must add up to 1.0.
	Weights *SearchWeightsRequest `json:"weights,omitempty"`
	// The configuration for merging results.
	ResultMerging *SearchResultMergingRequest `json:"result_merging,omitempty"`
	// The filters to apply to the search.
	Filters *SearchFiltersRequest `json:"filters,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchRequestOptionsRequest) String 

func (s *SearchRequestOptionsRequest) String() string

func (*SearchRequestOptionsRequest) UnmarshalJSON 

func (s *SearchRequestOptionsRequest) UnmarshalJSON(data []byte) error

type SearchResponse 

type SearchResponse struct {
	// The results of the search. Each result represents a chunk that matches the search query.
	Results []*SearchResult `json:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResponse) String 

func (s *SearchResponse) String() string

func (*SearchResponse) UnmarshalJSON 

func (s *SearchResponse) UnmarshalJSON(data []byte) error

type SearchResult 

type SearchResult struct {
	// The text of the chunk that matched the search query.
	Text string `json:"text"`
	// A score representing how well the chunk matches the search query.
	Score    float64  `json:"score"`
	Keywords []string `json:"keywords,omitempty"`
	// The document that contains the chunk that matched the search query.
	Document *SearchResultDocument `json:"document,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResult) String 

func (s *SearchResult) String() string

func (*SearchResult) UnmarshalJSON 

func (s *SearchResult) UnmarshalJSON(data []byte) error

type SearchResultDocument 

type SearchResultDocument struct {
	// The ID of the document.
	Id *string `json:"id,omitempty"`
	// The human-readable name for the document.
	Label string `json:"label"`
	// The unique ID of the document as represented in an external system and specified when it was originally uploaded.
	ExternalId *string `json:"external_id,omitempty"`
	// A previously supplied JSON object containing metadata that can be filtered on when searching.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResultDocument) String 

func (s *SearchResultDocument) String() string

func (*SearchResultDocument) UnmarshalJSON 

func (s *SearchResultDocument) UnmarshalJSON(data []byte) error

type SearchResultDocumentRequest 

type SearchResultDocumentRequest struct {
	// The ID of the document.
	Id *string `json:"id,omitempty"`
	// The human-readable name for the document.
	Label string `json:"label"`
	// The unique ID of the document as represented in an external system and specified when it was originally uploaded.
	ExternalId *string `json:"external_id,omitempty"`
	// A previously supplied JSON object containing metadata that can be filtered on when searching.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResultDocumentRequest) String 

func (s *SearchResultDocumentRequest) String() string

func (*SearchResultDocumentRequest) UnmarshalJSON 

func (s *SearchResultDocumentRequest) UnmarshalJSON(data []byte) error

type SearchResultMergingRequest 

type SearchResultMergingRequest struct {
	// Whether to enable merging results
	Enabled *bool `json:"enabled,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResultMergingRequest) String 

func (s *SearchResultMergingRequest) String() string

func (*SearchResultMergingRequest) UnmarshalJSON 

func (s *SearchResultMergingRequest) UnmarshalJSON(data []byte) error

type SearchResultRequest 

type SearchResultRequest struct {
	// The text of the chunk that matched the search query.
	Text string `json:"text"`
	// A score representing how well the chunk matches the search query.
	Score    float64  `json:"score"`
	Keywords []string `json:"keywords,omitempty"`
	// The document that contains the chunk that matched the search query.
	Document *SearchResultDocumentRequest `json:"document,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchResultRequest) String 

func (s *SearchResultRequest) String() string

func (*SearchResultRequest) UnmarshalJSON 

func (s *SearchResultRequest) UnmarshalJSON(data []byte) error

type SearchResultsEnum added in v0.2.1 

type SearchResultsEnum = string

type SearchWeightsRequest 

type SearchWeightsRequest struct {
	// The relative weight to give to semantic similarity
	SemanticSimilarity *float64 `json:"semantic_similarity,omitempty"`
	// The relative weight to give to keywords
	Keywords *float64 `json:"keywords,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchWeightsRequest) String 

func (s *SearchWeightsRequest) String() string

func (*SearchWeightsRequest) UnmarshalJSON 

func (s *SearchWeightsRequest) UnmarshalJSON(data []byte) error

type SentenceChunkerConfig added in v0.6.0 

type SentenceChunkerConfig struct {
	CharacterLimit  *int     `json:"character_limit,omitempty"`
	MinOverlapRatio *float64 `json:"min_overlap_ratio,omitempty"`
	// contains filtered or unexported fields
}

Configuration for sentence chunking

func (*SentenceChunkerConfig) String added in v0.6.0 

func (s *SentenceChunkerConfig) String() string

func (*SentenceChunkerConfig) UnmarshalJSON added in v0.6.0 

func (s *SentenceChunkerConfig) UnmarshalJSON(data []byte) error

type SentenceChunkerConfigRequest added in v0.6.0 

type SentenceChunkerConfigRequest struct {
	CharacterLimit  *int     `json:"character_limit,omitempty"`
	MinOverlapRatio *float64 `json:"min_overlap_ratio,omitempty"`
	// contains filtered or unexported fields
}

Configuration for sentence chunking

func (*SentenceChunkerConfigRequest) String added in v0.6.0 

func (s *SentenceChunkerConfigRequest) String() string

func (*SentenceChunkerConfigRequest) UnmarshalJSON added in v0.6.0 

func (s *SentenceChunkerConfigRequest) UnmarshalJSON(data []byte) error

type SentenceChunkerEnum added in v0.6.0 

type SentenceChunkerEnum = string

type SentenceChunking added in v0.6.0 

type SentenceChunking struct {
	ChunkerConfig *SentenceChunkerConfig `json:"chunker_config,omitempty"`
	// contains filtered or unexported fields
}

Sentence chunking

func (*SentenceChunking) String added in v0.6.0 

func (s *SentenceChunking) String() string

func (*SentenceChunking) UnmarshalJSON added in v0.6.0 

func (s *SentenceChunking) UnmarshalJSON(data []byte) error

type SentenceChunkingRequest added in v0.6.0 

type SentenceChunkingRequest struct {
	ChunkerConfig *SentenceChunkerConfigRequest `json:"chunker_config,omitempty"`
	// contains filtered or unexported fields
}

Sentence chunking

func (*SentenceChunkingRequest) String added in v0.6.0 

func (s *SentenceChunkingRequest) String() string

func (*SentenceChunkingRequest) UnmarshalJSON added in v0.6.0 

func (s *SentenceChunkingRequest) UnmarshalJSON(data []byte) error

type SentenceTransformersMultiQaMpnetBaseCosV1Enum added in v0.6.0 

type SentenceTransformersMultiQaMpnetBaseCosV1Enum = string

type SentenceTransformersMultiQaMpnetBaseDotV1Enum added in v0.6.0 

type SentenceTransformersMultiQaMpnetBaseDotV1Enum = string

type SlimDeploymentRead added in v0.2.0 

type SlimDeploymentRead struct {
	Id      string    `json:"id"`
	Created time.Time `json:"created"`
	// A human-readable label for the deployment
	Label string `json:"label"`
	// A name that uniquely identifies this deployment within its workspace
	Name string `json:"name"`
	// The current status of the deployment
	//
	// - `ACTIVE` - Active
	// - `ARCHIVED` - Archived
	Status *EntityStatus `json:"status,omitempty"`
	// The environment this deployment is used in
	//
	// - `DEVELOPMENT` - Development
	// - `STAGING` - Staging
	// - `PRODUCTION` - Production
	Environment    *EnvironmentEnum  `json:"environment,omitempty"`
	LastDeployedOn time.Time         `json:"last_deployed_on"`
	InputVariables []*VellumVariable `json:"input_variables,omitempty"`
	// contains filtered or unexported fields
}

func (*SlimDeploymentRead) String added in v0.2.0 

func (s *SlimDeploymentRead) String() string

func (*SlimDeploymentRead) UnmarshalJSON added in v0.2.0 

func (s *SlimDeploymentRead) UnmarshalJSON(data []byte) error

type SlimDocument 

type SlimDocument struct {
	// Vellum-generated ID that uniquely identifies this document.
	Id string `json:"id"`
	// The external ID that was originally provided when uploading the document.
	ExternalId *string `json:"external_id,omitempty"`
	// A timestamp representing when this document was most recently uploaded.
	LastUploadedAt time.Time `json:"last_uploaded_at"`
	// Human-friendly name for this document.
	Label string `json:"label"`
	// An enum value representing where this document is along its processing lifecycle. Note that this is different than its indexing lifecycle.
	//
	// - `QUEUED` - Queued
	// - `PROCESSING` - Processing
	// - `PROCESSED` - Processed
	// - `FAILED` - Failed
	ProcessingState *ProcessingStateEnum `json:"processing_state,omitempty"`
	// An enum value representing why the document could not be processed. Is null unless processing_state is FAILED.
	//
	// - `EXCEEDED_CHARACTER_LIMIT` - Exceeded Character Limit
	// - `INVALID_FILE` - Invalid File
	ProcessingFailureReason *ProcessingFailureReasonEnum `json:"processing_failure_reason,omitempty"`
	// The document's current status.
	//
	// - `ACTIVE` - Active
	Status *DocumentStatus `json:"status,omitempty"`
	// A list of keywords associated with this document. Originally provided when uploading the document.
	Keywords []string `json:"keywords,omitempty"`
	// A previously supplied JSON object containing metadata that can be filtered on when searching.
	Metadata                  map[string]interface{}             `json:"metadata,omitempty"`
	DocumentToDocumentIndexes []*DocumentDocumentToDocumentIndex `json:"document_to_document_indexes,omitempty"`
	// contains filtered or unexported fields
}

func (*SlimDocument) String 

func (s *SlimDocument) String() string

func (*SlimDocument) UnmarshalJSON 

func (s *SlimDocument) UnmarshalJSON(data []byte) error

type SlimWorkflowDeployment added in v0.2.0 

type SlimWorkflowDeployment struct {
	Id string `json:"id"`
	// A name that uniquely identifies this workflow deployment within its workspace
	Name string `json:"name"`
	// A human-readable label for the workflow deployment
	Label string `json:"label"`
	// The current status of the workflow deployment
	//
	// - `ACTIVE` - Active
	// - `ARCHIVED` - Archived
	Status *EntityStatus `json:"status,omitempty"`
	// The environment this workflow deployment is used in
	//
	// - `DEVELOPMENT` - Development
	// - `STAGING` - Staging
	// - `PRODUCTION` - Production
	Environment    *EnvironmentEnum `json:"environment,omitempty"`
	Created        time.Time        `json:"created"`
	LastDeployedOn time.Time        `json:"last_deployed_on"`
	// The input variables this Workflow Deployment expects to receive values for when it is executed.
	InputVariables []*VellumVariable `json:"input_variables,omitempty"`
	// The output variables this Workflow Deployment will produce when it is executed.
	OutputVariables []*VellumVariable `json:"output_variables,omitempty"`
	// contains filtered or unexported fields
}

func (*SlimWorkflowDeployment) String added in v0.2.0 

func (s *SlimWorkflowDeployment) String() string

func (*SlimWorkflowDeployment) UnmarshalJSON added in v0.2.0 

func (s *SlimWorkflowDeployment) UnmarshalJSON(data []byte) error

type StreamingEnum 

type StreamingEnum = string

type StreamingExecutePromptEvent 

type StreamingExecutePromptEvent struct {
	Output      *PromptOutput                 `json:"output,omitempty"`
	OutputIndex int                           `json:"output_index"`
	ExecutionId string                        `json:"execution_id"`
	Meta        *StreamingPromptExecutionMeta `json:"meta,omitempty"`
	// The subset of the raw response from the model that the request opted into with `expand_raw`.
	Raw map[string]interface{} `json:"raw,omitempty"`
	// contains filtered or unexported fields
}

The data returned for each delta during the prompt execution stream.

func (*StreamingExecutePromptEvent) String 

func (s *StreamingExecutePromptEvent) String() string

func (*StreamingExecutePromptEvent) UnmarshalJSON 

func (s *StreamingExecutePromptEvent) UnmarshalJSON(data []byte) error

type StreamingPromptExecutionMeta 

type StreamingPromptExecutionMeta struct {
	Latency *int `json:"latency,omitempty"`
	// contains filtered or unexported fields
}

The subset of the metadata tracked by Vellum during prompt execution that the request opted into with `expand_meta`.

func (*StreamingPromptExecutionMeta) String 

func (s *StreamingPromptExecutionMeta) String() string

func (*StreamingPromptExecutionMeta) UnmarshalJSON 

func (s *StreamingPromptExecutionMeta) UnmarshalJSON(data []byte) error

type StreamingWorkflowNodeResultEvent added in v0.3.0 

type StreamingWorkflowNodeResultEvent struct {
	Id                string                   `json:"id"`
	NodeId            string                   `json:"node_id"`
	NodeResultId      string                   `json:"node_result_id"`
	Ts                *time.Time               `json:"ts,omitempty"`
	Data              *WorkflowNodeResultData  `json:"data,omitempty"`
	SourceExecutionId *string                  `json:"source_execution_id,omitempty"`
	Output            *NodeOutputCompiledValue `json:"output,omitempty"`
	OutputIndex       *int                     `json:"output_index,omitempty"`
	// contains filtered or unexported fields
}

An event that indicates that the node has execution is in progress.

func (*StreamingWorkflowNodeResultEvent) String added in v0.3.0 

func (s *StreamingWorkflowNodeResultEvent) String() string

func (*StreamingWorkflowNodeResultEvent) UnmarshalJSON added in v0.3.0 

func (s *StreamingWorkflowNodeResultEvent) UnmarshalJSON(data []byte) error

type StringChatMessageContent added in v0.2.0 

type StringChatMessageContent struct {
	Value string `json:"value"`
	// contains filtered or unexported fields
}

A string value that is used in a chat message.

func (*StringChatMessageContent) String added in v0.2.0 

func (s *StringChatMessageContent) String() string

func (*StringChatMessageContent) UnmarshalJSON added in v0.2.0 

func (s *StringChatMessageContent) UnmarshalJSON(data []byte) error

type StringChatMessageContentRequest added in v0.2.0 

type StringChatMessageContentRequest struct {
	Value string `json:"value"`
	// contains filtered or unexported fields
}

A string value that is used in a chat message.

func (*StringChatMessageContentRequest) String added in v0.2.0 

func (s *StringChatMessageContentRequest) String() string

func (*StringChatMessageContentRequest) UnmarshalJSON added in v0.2.0 

func (s *StringChatMessageContentRequest) UnmarshalJSON(data []byte) error

type StringEnum added in v0.2.0 

type StringEnum = string

type StringInputRequest 

type StringInputRequest struct {
	// The variable's name, as defined in the deployment.
	Name  string `json:"name"`
	Value string `json:"value"`
	// contains filtered or unexported fields
}

A user input representing a string value

func (*StringInputRequest) String 

func (s *StringInputRequest) String() string

func (*StringInputRequest) UnmarshalJSON 

func (s *StringInputRequest) UnmarshalJSON(data []byte) error

type StringVariableValue 

type StringVariableValue struct {
	Value *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*StringVariableValue) String 

func (s *StringVariableValue) String() string

func (*StringVariableValue) UnmarshalJSON 

func (s *StringVariableValue) UnmarshalJSON(data []byte) error

type StringVellumValue added in v0.5.2 

type StringVellumValue struct {
	Value *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A value representing a string.

func (*StringVellumValue) String added in v0.5.2 

func (s *StringVellumValue) String() string

func (*StringVellumValue) UnmarshalJSON added in v0.5.2 

func (s *StringVellumValue) UnmarshalJSON(data []byte) error

type SubmitCompletionActualRequest 

type SubmitCompletionActualRequest struct {
	// The Vellum-generated ID of a previously generated completion. Must provide either this or external_id.
	Id *string `json:"id,omitempty"`
	// The external ID that was originally provided when generating the completion that you'd now like to submit actuals for. Must provide either this or id.
	ExternalId *string `json:"external_id,omitempty"`
	// Text representing what the completion _should_ have been.
	Text *string `json:"text,omitempty"`
	// A number between 0 and 1 representing the quality of the completion. 0 is the worst, 1 is the best.
	Quality *float64 `json:"quality,omitempty"`
	// Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes.
	Timestamp *time.Time `json:"timestamp,omitempty"`
	// Optionally provide additional metadata about the feedback submission.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*SubmitCompletionActualRequest) String 

func (s *SubmitCompletionActualRequest) String() string

func (*SubmitCompletionActualRequest) UnmarshalJSON 

func (s *SubmitCompletionActualRequest) UnmarshalJSON(data []byte) error

type SubmitCompletionActualsErrorResponse 

type SubmitCompletionActualsErrorResponse struct {
	Detail string `json:"detail"`
	// contains filtered or unexported fields
}

func (*SubmitCompletionActualsErrorResponse) String 

func (s *SubmitCompletionActualsErrorResponse) String() string

func (*SubmitCompletionActualsErrorResponse) UnmarshalJSON 

func (s *SubmitCompletionActualsErrorResponse) UnmarshalJSON(data []byte) error

type SubmitCompletionActualsRequest 

type SubmitCompletionActualsRequest struct {
	// The ID of the deployment. Must provide either this or deployment_name.
	DeploymentId *string `json:"deployment_id,omitempty"`
	// The name of the deployment. Must provide either this or deployment_id.
	DeploymentName *string `json:"deployment_name,omitempty"`
	// Feedback regarding the quality of previously generated completions
	Actuals []*SubmitCompletionActualRequest `json:"actuals,omitempty"`
}

type SubmitWorkflowExecutionActualRequest 

type SubmitWorkflowExecutionActualRequest struct {
	OutputType  string
	String      *WorkflowExecutionActualStringRequest
	Json        *WorkflowExecutionActualJsonRequest
	ChatHistory *WorkflowExecutionActualChatHistoryRequest
}

func NewSubmitWorkflowExecutionActualRequestFromChatHistory 

func NewSubmitWorkflowExecutionActualRequestFromChatHistory(value *WorkflowExecutionActualChatHistoryRequest) *SubmitWorkflowExecutionActualRequest

func NewSubmitWorkflowExecutionActualRequestFromJson 

func NewSubmitWorkflowExecutionActualRequestFromJson(value *WorkflowExecutionActualJsonRequest) *SubmitWorkflowExecutionActualRequest

func NewSubmitWorkflowExecutionActualRequestFromString 

func NewSubmitWorkflowExecutionActualRequestFromString(value *WorkflowExecutionActualStringRequest) *SubmitWorkflowExecutionActualRequest

func (*SubmitWorkflowExecutionActualRequest) Accept 

func (s *SubmitWorkflowExecutionActualRequest) Accept(visitor SubmitWorkflowExecutionActualRequestVisitor) error

func (SubmitWorkflowExecutionActualRequest) MarshalJSON 

func (s SubmitWorkflowExecutionActualRequest) MarshalJSON() ([]byte, error)

func (*SubmitWorkflowExecutionActualRequest) UnmarshalJSON 

func (s *SubmitWorkflowExecutionActualRequest) UnmarshalJSON(data []byte) error

type SubmitWorkflowExecutionActualRequestVisitor 

type SubmitWorkflowExecutionActualRequestVisitor interface {
	VisitString(*WorkflowExecutionActualStringRequest) error
	VisitJson(*WorkflowExecutionActualJsonRequest) error
	VisitChatHistory(*WorkflowExecutionActualChatHistoryRequest) error
}

type SubmitWorkflowExecutionActualsRequest 

type SubmitWorkflowExecutionActualsRequest struct {
	// Feedback regarding the quality of an output on a previously executed workflow.
	Actuals []*SubmitWorkflowExecutionActualRequest `json:"actuals,omitempty"`
	// The Vellum-generated ID of a previously executed workflow. Must provide either this or external_id.
	ExecutionId *string `json:"execution_id,omitempty"`
	// The external ID that was originally provided by when executing the workflow, if applicable, that you'd now like to submit actuals for. Must provide either this or execution_id.
	ExternalId *string `json:"external_id,omitempty"`
}

type SubworkflowEnum added in v0.3.9 

type SubworkflowEnum = string

type SubworkflowNodeResult added in v0.3.9 

type SubworkflowNodeResult struct {
	// contains filtered or unexported fields
}

A Node Result Event emitted from a Subworkflow Node.

func (*SubworkflowNodeResult) String added in v0.3.9 

func (s *SubworkflowNodeResult) String() string

func (*SubworkflowNodeResult) UnmarshalJSON added in v0.3.9 

func (s *SubworkflowNodeResult) UnmarshalJSON(data []byte) error

type TemplatingNodeArrayResult added in v0.3.15 

type TemplatingNodeArrayResult struct {
	Id    string                    `json:"id"`
	Value []*ArrayVariableValueItem `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatingNodeArrayResult) String added in v0.3.15 

func (t *TemplatingNodeArrayResult) String() string

func (*TemplatingNodeArrayResult) UnmarshalJSON added in v0.3.15 

func (t *TemplatingNodeArrayResult) UnmarshalJSON(data []byte) error

type TemplatingNodeChatHistoryResult 

type TemplatingNodeChatHistoryResult struct {
	Id    string         `json:"id"`
	Value []*ChatMessage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatingNodeChatHistoryResult) String 

func (t *TemplatingNodeChatHistoryResult) String() string

func (*TemplatingNodeChatHistoryResult) UnmarshalJSON 

func (t *TemplatingNodeChatHistoryResult) UnmarshalJSON(data []byte) error

type TemplatingNodeErrorResult 

type TemplatingNodeErrorResult struct {
	Id    string       `json:"id"`
	Value *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatingNodeErrorResult) String 

func (t *TemplatingNodeErrorResult) String() string

func (*TemplatingNodeErrorResult) UnmarshalJSON 

func (t *TemplatingNodeErrorResult) UnmarshalJSON(data []byte) error

type TemplatingNodeFunctionCallResult added in v0.3.15 

type TemplatingNodeFunctionCallResult struct {
	Id    string        `json:"id"`
	Value *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatingNodeFunctionCallResult) String added in v0.3.15 

func (t *TemplatingNodeFunctionCallResult) String() string

func (*TemplatingNodeFunctionCallResult) UnmarshalJSON added in v0.3.15 

func (t *TemplatingNodeFunctionCallResult) UnmarshalJSON(data []byte) error

type TemplatingNodeJsonResult 

type TemplatingNodeJsonResult struct {
	Id    string                 `json:"id"`
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatingNodeJsonResult) String 

func (t *TemplatingNodeJsonResult) String() string

func (*TemplatingNodeJsonResult) UnmarshalJSON 

func (t *TemplatingNodeJsonResult) UnmarshalJSON(data []byte) error

type TemplatingNodeNumberResult 

type TemplatingNodeNumberResult struct {
	Id    string   `json:"id"`
	Value *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatingNodeNumberResult) String 

func (t *TemplatingNodeNumberResult) String() string

func (*TemplatingNodeNumberResult) UnmarshalJSON 

func (t *TemplatingNodeNumberResult) UnmarshalJSON(data []byte) error

type TemplatingNodeResult 

type TemplatingNodeResult struct {
	Data *TemplatingNodeResultData `json:"data,omitempty"`
	// contains filtered or unexported fields
}

A Node Result Event emitted from a Templating Node.

func (*TemplatingNodeResult) String 

func (t *TemplatingNodeResult) String() string

func (*TemplatingNodeResult) UnmarshalJSON 

func (t *TemplatingNodeResult) UnmarshalJSON(data []byte) error

type TemplatingNodeResultData 

type TemplatingNodeResultData struct {
	Output *TemplatingNodeResultOutput `json:"output,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatingNodeResultData) String 

func (t *TemplatingNodeResultData) String() string

func (*TemplatingNodeResultData) UnmarshalJSON 

func (t *TemplatingNodeResultData) UnmarshalJSON(data []byte) error

type TemplatingNodeResultOutput 

type TemplatingNodeResultOutput struct {
	Type          string
	String        *TemplatingNodeStringResult
	Number        *TemplatingNodeNumberResult
	Json          *TemplatingNodeJsonResult
	ChatHistory   *TemplatingNodeChatHistoryResult
	SearchResults *TemplatingNodeSearchResultsResult
	Error         *TemplatingNodeErrorResult
	Array         *TemplatingNodeArrayResult
	FunctionCall  *TemplatingNodeFunctionCallResult
}

func NewTemplatingNodeResultOutputFromArray added in v0.3.15 

func NewTemplatingNodeResultOutputFromArray(value *TemplatingNodeArrayResult) *TemplatingNodeResultOutput

func NewTemplatingNodeResultOutputFromChatHistory 

func NewTemplatingNodeResultOutputFromChatHistory(value *TemplatingNodeChatHistoryResult) *TemplatingNodeResultOutput

func NewTemplatingNodeResultOutputFromError 

func NewTemplatingNodeResultOutputFromError(value *TemplatingNodeErrorResult) *TemplatingNodeResultOutput

func NewTemplatingNodeResultOutputFromFunctionCall added in v0.3.15 

func NewTemplatingNodeResultOutputFromFunctionCall(value *TemplatingNodeFunctionCallResult) *TemplatingNodeResultOutput

func NewTemplatingNodeResultOutputFromJson 

func NewTemplatingNodeResultOutputFromJson(value *TemplatingNodeJsonResult) *TemplatingNodeResultOutput

func NewTemplatingNodeResultOutputFromNumber 

func NewTemplatingNodeResultOutputFromNumber(value *TemplatingNodeNumberResult) *TemplatingNodeResultOutput

func NewTemplatingNodeResultOutputFromSearchResults 

func NewTemplatingNodeResultOutputFromSearchResults(value *TemplatingNodeSearchResultsResult) *TemplatingNodeResultOutput

func NewTemplatingNodeResultOutputFromString 

func NewTemplatingNodeResultOutputFromString(value *TemplatingNodeStringResult) *TemplatingNodeResultOutput

func (*TemplatingNodeResultOutput) Accept 

func (t *TemplatingNodeResultOutput) Accept(visitor TemplatingNodeResultOutputVisitor) error

func (TemplatingNodeResultOutput) MarshalJSON 

func (t TemplatingNodeResultOutput) MarshalJSON() ([]byte, error)

func (*TemplatingNodeResultOutput) UnmarshalJSON 

func (t *TemplatingNodeResultOutput) UnmarshalJSON(data []byte) error

type TemplatingNodeResultOutputVisitor 

type TemplatingNodeResultOutputVisitor interface {
	VisitString(*TemplatingNodeStringResult) error
	VisitNumber(*TemplatingNodeNumberResult) error
	VisitJson(*TemplatingNodeJsonResult) error
	VisitChatHistory(*TemplatingNodeChatHistoryResult) error
	VisitSearchResults(*TemplatingNodeSearchResultsResult) error
	VisitError(*TemplatingNodeErrorResult) error
	VisitArray(*TemplatingNodeArrayResult) error
	VisitFunctionCall(*TemplatingNodeFunctionCallResult) error
}

type TemplatingNodeSearchResultsResult 

type TemplatingNodeSearchResultsResult struct {
	Id    string          `json:"id"`
	Value []*SearchResult `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatingNodeSearchResultsResult) String 

func (t *TemplatingNodeSearchResultsResult) String() string

func (*TemplatingNodeSearchResultsResult) UnmarshalJSON 

func (t *TemplatingNodeSearchResultsResult) UnmarshalJSON(data []byte) error

type TemplatingNodeStringResult 

type TemplatingNodeStringResult struct {
	Id    string  `json:"id"`
	Value *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TemplatingNodeStringResult) String 

func (t *TemplatingNodeStringResult) String() string

func (*TemplatingNodeStringResult) UnmarshalJSON 

func (t *TemplatingNodeStringResult) UnmarshalJSON(data []byte) error

type TerminalNodeArrayResult added in v0.3.9 

type TerminalNodeArrayResult struct {
	Id *string `json:"id,omitempty"`
	// The unique name given to the terminal node that produced this output.
	Name  string                    `json:"name"`
	Value []*ArrayVariableValueItem `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalNodeArrayResult) String added in v0.3.9 

func (t *TerminalNodeArrayResult) String() string

func (*TerminalNodeArrayResult) UnmarshalJSON added in v0.3.9 

func (t *TerminalNodeArrayResult) UnmarshalJSON(data []byte) error

type TerminalNodeChatHistoryResult 

type TerminalNodeChatHistoryResult struct {
	Id *string `json:"id,omitempty"`
	// The unique name given to the terminal node that produced this output.
	Name  string         `json:"name"`
	Value []*ChatMessage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalNodeChatHistoryResult) String 

func (t *TerminalNodeChatHistoryResult) String() string

func (*TerminalNodeChatHistoryResult) UnmarshalJSON 

func (t *TerminalNodeChatHistoryResult) UnmarshalJSON(data []byte) error

type TerminalNodeErrorResult 

type TerminalNodeErrorResult struct {
	Id *string `json:"id,omitempty"`
	// The unique name given to the terminal node that produced this output.
	Name  string       `json:"name"`
	Value *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalNodeErrorResult) String 

func (t *TerminalNodeErrorResult) String() string

func (*TerminalNodeErrorResult) UnmarshalJSON 

func (t *TerminalNodeErrorResult) UnmarshalJSON(data []byte) error

type TerminalNodeFunctionCallResult added in v0.3.9 

type TerminalNodeFunctionCallResult struct {
	Id *string `json:"id,omitempty"`
	// The unique name given to the terminal node that produced this output.
	Name  string        `json:"name"`
	Value *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalNodeFunctionCallResult) String added in v0.3.9 

func (t *TerminalNodeFunctionCallResult) String() string

func (*TerminalNodeFunctionCallResult) UnmarshalJSON added in v0.3.9 

func (t *TerminalNodeFunctionCallResult) UnmarshalJSON(data []byte) error

type TerminalNodeJsonResult 

type TerminalNodeJsonResult struct {
	Id *string `json:"id,omitempty"`
	// The unique name given to the terminal node that produced this output.
	Name  string                 `json:"name"`
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalNodeJsonResult) String 

func (t *TerminalNodeJsonResult) String() string

func (*TerminalNodeJsonResult) UnmarshalJSON 

func (t *TerminalNodeJsonResult) UnmarshalJSON(data []byte) error

type TerminalNodeNumberResult 

type TerminalNodeNumberResult struct {
	Id *string `json:"id,omitempty"`
	// The unique name given to the terminal node that produced this output.
	Name  string   `json:"name"`
	Value *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalNodeNumberResult) String 

func (t *TerminalNodeNumberResult) String() string

func (*TerminalNodeNumberResult) UnmarshalJSON 

func (t *TerminalNodeNumberResult) UnmarshalJSON(data []byte) error

type TerminalNodeResult 

type TerminalNodeResult struct {
	Data *TerminalNodeResultData `json:"data,omitempty"`
	// contains filtered or unexported fields
}

A Node Result Event emitted from a Terminal Node.

func (*TerminalNodeResult) String 

func (t *TerminalNodeResult) String() string

func (*TerminalNodeResult) UnmarshalJSON 

func (t *TerminalNodeResult) UnmarshalJSON(data []byte) error

type TerminalNodeResultData 

type TerminalNodeResultData struct {
	Output *TerminalNodeResultOutput `json:"output,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalNodeResultData) String 

func (t *TerminalNodeResultData) String() string

func (*TerminalNodeResultData) UnmarshalJSON 

func (t *TerminalNodeResultData) UnmarshalJSON(data []byte) error

type TerminalNodeResultOutput 

type TerminalNodeResultOutput struct {
	Type          string
	String        *TerminalNodeStringResult
	Number        *TerminalNodeNumberResult
	Json          *TerminalNodeJsonResult
	ChatHistory   *TerminalNodeChatHistoryResult
	SearchResults *TerminalNodeSearchResultsResult
	Array         *TerminalNodeArrayResult
	FunctionCall  *TerminalNodeFunctionCallResult
	Error         *TerminalNodeErrorResult
}

func NewTerminalNodeResultOutputFromArray added in v0.3.9 

func NewTerminalNodeResultOutputFromArray(value *TerminalNodeArrayResult) *TerminalNodeResultOutput

func NewTerminalNodeResultOutputFromChatHistory 

func NewTerminalNodeResultOutputFromChatHistory(value *TerminalNodeChatHistoryResult) *TerminalNodeResultOutput

func NewTerminalNodeResultOutputFromError 

func NewTerminalNodeResultOutputFromError(value *TerminalNodeErrorResult) *TerminalNodeResultOutput

func NewTerminalNodeResultOutputFromFunctionCall added in v0.3.9 

func NewTerminalNodeResultOutputFromFunctionCall(value *TerminalNodeFunctionCallResult) *TerminalNodeResultOutput

func NewTerminalNodeResultOutputFromJson 

func NewTerminalNodeResultOutputFromJson(value *TerminalNodeJsonResult) *TerminalNodeResultOutput

func NewTerminalNodeResultOutputFromNumber 

func NewTerminalNodeResultOutputFromNumber(value *TerminalNodeNumberResult) *TerminalNodeResultOutput

func NewTerminalNodeResultOutputFromSearchResults 

func NewTerminalNodeResultOutputFromSearchResults(value *TerminalNodeSearchResultsResult) *TerminalNodeResultOutput

func NewTerminalNodeResultOutputFromString 

func NewTerminalNodeResultOutputFromString(value *TerminalNodeStringResult) *TerminalNodeResultOutput

func (*TerminalNodeResultOutput) Accept 

func (t *TerminalNodeResultOutput) Accept(visitor TerminalNodeResultOutputVisitor) error

func (TerminalNodeResultOutput) MarshalJSON 

func (t TerminalNodeResultOutput) MarshalJSON() ([]byte, error)

func (*TerminalNodeResultOutput) UnmarshalJSON 

func (t *TerminalNodeResultOutput) UnmarshalJSON(data []byte) error

type TerminalNodeResultOutputVisitor 

type TerminalNodeResultOutputVisitor interface {
	VisitString(*TerminalNodeStringResult) error
	VisitNumber(*TerminalNodeNumberResult) error
	VisitJson(*TerminalNodeJsonResult) error
	VisitChatHistory(*TerminalNodeChatHistoryResult) error
	VisitSearchResults(*TerminalNodeSearchResultsResult) error
	VisitArray(*TerminalNodeArrayResult) error
	VisitFunctionCall(*TerminalNodeFunctionCallResult) error
	VisitError(*TerminalNodeErrorResult) error
}

type TerminalNodeSearchResultsResult 

type TerminalNodeSearchResultsResult struct {
	Id *string `json:"id,omitempty"`
	// The unique name given to the terminal node that produced this output.
	Name  string          `json:"name"`
	Value []*SearchResult `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalNodeSearchResultsResult) String 

func (t *TerminalNodeSearchResultsResult) String() string

func (*TerminalNodeSearchResultsResult) UnmarshalJSON 

func (t *TerminalNodeSearchResultsResult) UnmarshalJSON(data []byte) error

type TerminalNodeStringResult 

type TerminalNodeStringResult struct {
	Id *string `json:"id,omitempty"`
	// The unique name given to the terminal node that produced this output.
	Name  string  `json:"name"`
	Value *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*TerminalNodeStringResult) String 

func (t *TerminalNodeStringResult) String() string

func (*TerminalNodeStringResult) UnmarshalJSON 

func (t *TerminalNodeStringResult) UnmarshalJSON(data []byte) error

type TestCaseChatHistoryVariableValue 

type TestCaseChatHistoryVariableValue struct {
	VariableId string         `json:"variable_id"`
	Name       string         `json:"name"`
	Value      []*ChatMessage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A chat history value for a variable in a Test Case.

func (*TestCaseChatHistoryVariableValue) String 

func (t *TestCaseChatHistoryVariableValue) String() string

func (*TestCaseChatHistoryVariableValue) UnmarshalJSON 

func (t *TestCaseChatHistoryVariableValue) UnmarshalJSON(data []byte) error

type TestCaseErrorVariableValue 

type TestCaseErrorVariableValue struct {
	VariableId string       `json:"variable_id"`
	Name       string       `json:"name"`
	Value      *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

An error value for a variable in a Test Case.

func (*TestCaseErrorVariableValue) String 

func (t *TestCaseErrorVariableValue) String() string

func (*TestCaseErrorVariableValue) UnmarshalJSON 

func (t *TestCaseErrorVariableValue) UnmarshalJSON(data []byte) error

type TestCaseFunctionCallVariableValue added in v0.4.0 

type TestCaseFunctionCallVariableValue struct {
	VariableId string        `json:"variable_id"`
	Name       string        `json:"name"`
	Value      *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A function call value for a variable in a Test Case.

func (*TestCaseFunctionCallVariableValue) String added in v0.4.0 

func (t *TestCaseFunctionCallVariableValue) String() string

func (*TestCaseFunctionCallVariableValue) UnmarshalJSON added in v0.4.0 

func (t *TestCaseFunctionCallVariableValue) UnmarshalJSON(data []byte) error

type TestCaseJsonVariableValue 

type TestCaseJsonVariableValue struct {
	VariableId string                 `json:"variable_id"`
	Name       string                 `json:"name"`
	Value      map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A JSON value for a variable in a Test Case.

func (*TestCaseJsonVariableValue) String 

func (t *TestCaseJsonVariableValue) String() string

func (*TestCaseJsonVariableValue) UnmarshalJSON 

func (t *TestCaseJsonVariableValue) UnmarshalJSON(data []byte) error

type TestCaseNumberVariableValue 

type TestCaseNumberVariableValue struct {
	VariableId string   `json:"variable_id"`
	Name       string   `json:"name"`
	Value      *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A numerical value for a variable in a Test Case.

func (*TestCaseNumberVariableValue) String 

func (t *TestCaseNumberVariableValue) String() string

func (*TestCaseNumberVariableValue) UnmarshalJSON 

func (t *TestCaseNumberVariableValue) UnmarshalJSON(data []byte) error

type TestCaseSearchResultsVariableValue 

type TestCaseSearchResultsVariableValue struct {
	VariableId string          `json:"variable_id"`
	Name       string          `json:"name"`
	Value      []*SearchResult `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A search results value for a variable in a Test Case.

func (*TestCaseSearchResultsVariableValue) String 

func (t *TestCaseSearchResultsVariableValue) String() string

func (*TestCaseSearchResultsVariableValue) UnmarshalJSON 

func (t *TestCaseSearchResultsVariableValue) UnmarshalJSON(data []byte) error

type TestCaseStringVariableValue 

type TestCaseStringVariableValue struct {
	VariableId string  `json:"variable_id"`
	Name       string  `json:"name"`
	Value      *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A string value for a variable in a Test Case.

func (*TestCaseStringVariableValue) String 

func (t *TestCaseStringVariableValue) String() string

func (*TestCaseStringVariableValue) UnmarshalJSON 

func (t *TestCaseStringVariableValue) UnmarshalJSON(data []byte) error

type TestCaseVariableValue 

type TestCaseVariableValue struct {
	Type          string
	String        *TestCaseStringVariableValue
	Number        *TestCaseNumberVariableValue
	Json          *TestCaseJsonVariableValue
	ChatHistory   *TestCaseChatHistoryVariableValue
	SearchResults *TestCaseSearchResultsVariableValue
	Error         *TestCaseErrorVariableValue
	FunctionCall  *TestCaseFunctionCallVariableValue
}

func NewTestCaseVariableValueFromChatHistory 

func NewTestCaseVariableValueFromChatHistory(value *TestCaseChatHistoryVariableValue) *TestCaseVariableValue

func NewTestCaseVariableValueFromError 

func NewTestCaseVariableValueFromError(value *TestCaseErrorVariableValue) *TestCaseVariableValue

func NewTestCaseVariableValueFromFunctionCall added in v0.4.0 

func NewTestCaseVariableValueFromFunctionCall(value *TestCaseFunctionCallVariableValue) *TestCaseVariableValue

func NewTestCaseVariableValueFromJson 

func NewTestCaseVariableValueFromJson(value *TestCaseJsonVariableValue) *TestCaseVariableValue

func NewTestCaseVariableValueFromNumber 

func NewTestCaseVariableValueFromNumber(value *TestCaseNumberVariableValue) *TestCaseVariableValue

func NewTestCaseVariableValueFromSearchResults 

func NewTestCaseVariableValueFromSearchResults(value *TestCaseSearchResultsVariableValue) *TestCaseVariableValue

func NewTestCaseVariableValueFromString 

func NewTestCaseVariableValueFromString(value *TestCaseStringVariableValue) *TestCaseVariableValue

func (*TestCaseVariableValue) Accept 

func (t *TestCaseVariableValue) Accept(visitor TestCaseVariableValueVisitor) error

func (TestCaseVariableValue) MarshalJSON 

func (t TestCaseVariableValue) MarshalJSON() ([]byte, error)

func (*TestCaseVariableValue) UnmarshalJSON 

func (t *TestCaseVariableValue) UnmarshalJSON(data []byte) error

type TestCaseVariableValueVisitor 

type TestCaseVariableValueVisitor interface {
	VisitString(*TestCaseStringVariableValue) error
	VisitNumber(*TestCaseNumberVariableValue) error
	VisitJson(*TestCaseJsonVariableValue) error
	VisitChatHistory(*TestCaseChatHistoryVariableValue) error
	VisitSearchResults(*TestCaseSearchResultsVariableValue) error
	VisitError(*TestCaseErrorVariableValue) error
	VisitFunctionCall(*TestCaseFunctionCallVariableValue) error
}

type TestSuiteRunCreateRequest added in v0.3.13 

type TestSuiteRunCreateRequest struct {
	// The ID of the Test Suite to run
	TestSuiteId string `json:"test_suite_id"`
	// Configuration that defines how the Test Suite should be run
	ExecConfig *TestSuiteRunExecConfigRequest `json:"exec_config,omitempty"`
}

type TestSuiteRunDeploymentReleaseTagExecConfig added in v0.3.13 

type TestSuiteRunDeploymentReleaseTagExecConfig struct {
	Data *TestSuiteRunDeploymentReleaseTagExecConfigData `json:"data,omitempty"`
	// Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
	TestCaseIds []string `json:"test_case_ids,omitempty"`
	// contains filtered or unexported fields
}

Execution configuration for running a Test Suite against a Prompt Deployment

func (*TestSuiteRunDeploymentReleaseTagExecConfig) String added in v0.3.13 

func (t *TestSuiteRunDeploymentReleaseTagExecConfig) String() string

func (*TestSuiteRunDeploymentReleaseTagExecConfig) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunDeploymentReleaseTagExecConfig) UnmarshalJSON(data []byte) error

type TestSuiteRunDeploymentReleaseTagExecConfigData added in v0.3.13 

type TestSuiteRunDeploymentReleaseTagExecConfigData struct {
	// The ID of the Prompt Deployment to run the Test Suite against.
	DeploymentId string `json:"deployment_id"`
	// A tag identifying which release of the Prompt Deployment to run the Test Suite against. Useful for testing past versions of the Prompt Deployment
	Tag *string `json:"tag,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunDeploymentReleaseTagExecConfigData) String added in v0.3.13 

func (t *TestSuiteRunDeploymentReleaseTagExecConfigData) String() string

func (*TestSuiteRunDeploymentReleaseTagExecConfigData) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunDeploymentReleaseTagExecConfigData) UnmarshalJSON(data []byte) error

type TestSuiteRunDeploymentReleaseTagExecConfigDataRequest added in v0.3.13 

type TestSuiteRunDeploymentReleaseTagExecConfigDataRequest struct {
	// The ID of the Prompt Deployment to run the Test Suite against.
	DeploymentId string `json:"deployment_id"`
	// A tag identifying which release of the Prompt Deployment to run the Test Suite against. Useful for testing past versions of the Prompt Deployment
	Tag *string `json:"tag,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunDeploymentReleaseTagExecConfigDataRequest) String added in v0.3.13 

func (t *TestSuiteRunDeploymentReleaseTagExecConfigDataRequest) String() string

func (*TestSuiteRunDeploymentReleaseTagExecConfigDataRequest) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunDeploymentReleaseTagExecConfigDataRequest) UnmarshalJSON(data []byte) error

type TestSuiteRunDeploymentReleaseTagExecConfigRequest added in v0.3.13 

type TestSuiteRunDeploymentReleaseTagExecConfigRequest struct {
	Data *TestSuiteRunDeploymentReleaseTagExecConfigDataRequest `json:"data,omitempty"`
	// Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
	TestCaseIds []string `json:"test_case_ids,omitempty"`
	// contains filtered or unexported fields
}

Execution configuration for running a Test Suite against a Prompt Deployment

func (*TestSuiteRunDeploymentReleaseTagExecConfigRequest) String added in v0.3.13 

func (t *TestSuiteRunDeploymentReleaseTagExecConfigRequest) String() string

func (*TestSuiteRunDeploymentReleaseTagExecConfigRequest) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunDeploymentReleaseTagExecConfigRequest) UnmarshalJSON(data []byte) error

type TestSuiteRunDeploymentReleaseTagExecConfigTypeEnum added in v0.3.13 

type TestSuiteRunDeploymentReleaseTagExecConfigTypeEnum = string

- `DEPLOYMENT_RELEASE_TAG` - DEPLOYMENT_RELEASE_TAG

type TestSuiteRunExecConfig added in v0.3.13 

type TestSuiteRunExecConfig struct {
	Type                 string
	DeploymentReleaseTag *TestSuiteRunDeploymentReleaseTagExecConfig
	WorkflowReleaseTag   *TestSuiteRunWorkflowReleaseTagExecConfig
	External             *TestSuiteRunExternalExecConfig
}

func NewTestSuiteRunExecConfigFromDeploymentReleaseTag added in v0.3.13 

func NewTestSuiteRunExecConfigFromDeploymentReleaseTag(value *TestSuiteRunDeploymentReleaseTagExecConfig) *TestSuiteRunExecConfig

func NewTestSuiteRunExecConfigFromExternal added in v0.3.23 

func NewTestSuiteRunExecConfigFromExternal(value *TestSuiteRunExternalExecConfig) *TestSuiteRunExecConfig

func NewTestSuiteRunExecConfigFromWorkflowReleaseTag added in v0.3.13 

func NewTestSuiteRunExecConfigFromWorkflowReleaseTag(value *TestSuiteRunWorkflowReleaseTagExecConfig) *TestSuiteRunExecConfig

func (*TestSuiteRunExecConfig) Accept added in v0.3.13 

func (t *TestSuiteRunExecConfig) Accept(visitor TestSuiteRunExecConfigVisitor) error

func (TestSuiteRunExecConfig) MarshalJSON added in v0.3.13 

func (t TestSuiteRunExecConfig) MarshalJSON() ([]byte, error)

func (*TestSuiteRunExecConfig) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecConfig) UnmarshalJSON(data []byte) error

type TestSuiteRunExecConfigRequest added in v0.3.13 

type TestSuiteRunExecConfigRequest struct {
	Type                 string
	DeploymentReleaseTag *TestSuiteRunDeploymentReleaseTagExecConfigRequest
	WorkflowReleaseTag   *TestSuiteRunWorkflowReleaseTagExecConfigRequest
	External             *TestSuiteRunExternalExecConfigRequest
}

func NewTestSuiteRunExecConfigRequestFromDeploymentReleaseTag added in v0.3.13 

func NewTestSuiteRunExecConfigRequestFromDeploymentReleaseTag(value *TestSuiteRunDeploymentReleaseTagExecConfigRequest) *TestSuiteRunExecConfigRequest

func NewTestSuiteRunExecConfigRequestFromExternal added in v0.3.23 

func NewTestSuiteRunExecConfigRequestFromExternal(value *TestSuiteRunExternalExecConfigRequest) *TestSuiteRunExecConfigRequest

func NewTestSuiteRunExecConfigRequestFromWorkflowReleaseTag added in v0.3.13 

func NewTestSuiteRunExecConfigRequestFromWorkflowReleaseTag(value *TestSuiteRunWorkflowReleaseTagExecConfigRequest) *TestSuiteRunExecConfigRequest

func (*TestSuiteRunExecConfigRequest) Accept added in v0.3.13 

func (t *TestSuiteRunExecConfigRequest) Accept(visitor TestSuiteRunExecConfigRequestVisitor) error

func (TestSuiteRunExecConfigRequest) MarshalJSON added in v0.3.13 

func (t TestSuiteRunExecConfigRequest) MarshalJSON() ([]byte, error)

func (*TestSuiteRunExecConfigRequest) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecConfigRequest) UnmarshalJSON(data []byte) error

type TestSuiteRunExecConfigRequestVisitor added in v0.3.13 

type TestSuiteRunExecConfigRequestVisitor interface {
	VisitDeploymentReleaseTag(*TestSuiteRunDeploymentReleaseTagExecConfigRequest) error
	VisitWorkflowReleaseTag(*TestSuiteRunWorkflowReleaseTagExecConfigRequest) error
	VisitExternal(*TestSuiteRunExternalExecConfigRequest) error
}

type TestSuiteRunExecConfigVisitor added in v0.3.13 

type TestSuiteRunExecConfigVisitor interface {
	VisitDeploymentReleaseTag(*TestSuiteRunDeploymentReleaseTagExecConfig) error
	VisitWorkflowReleaseTag(*TestSuiteRunWorkflowReleaseTagExecConfig) error
	VisitExternal(*TestSuiteRunExternalExecConfig) error
}

type TestSuiteRunExecution added in v0.3.13 

type TestSuiteRunExecution struct {
	Id            string                               `json:"id"`
	TestCaseId    string                               `json:"test_case_id"`
	Outputs       []*TestSuiteRunExecutionOutput       `json:"outputs,omitempty"`
	MetricResults []*TestSuiteRunExecutionMetricResult `json:"metric_results,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunExecution) String added in v0.3.13 

func (t *TestSuiteRunExecution) String() string

func (*TestSuiteRunExecution) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecution) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionChatHistoryOutput added in v0.3.13 

type TestSuiteRunExecutionChatHistoryOutput struct {
	Name             string         `json:"name"`
	Value            []*ChatMessage `json:"value,omitempty"`
	OutputVariableId string         `json:"output_variable_id"`
	// contains filtered or unexported fields
}

Execution output of an entity evaluated during a Test Suite Run that is of type CHAT_HISTORY

func (*TestSuiteRunExecutionChatHistoryOutput) String added in v0.3.13 

func (t *TestSuiteRunExecutionChatHistoryOutput) String() string

func (*TestSuiteRunExecutionChatHistoryOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecutionChatHistoryOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionErrorOutput added in v0.3.13 

type TestSuiteRunExecutionErrorOutput struct {
	Name             string       `json:"name"`
	Value            *VellumError `json:"value,omitempty"`
	OutputVariableId string       `json:"output_variable_id"`
	// contains filtered or unexported fields
}

Execution output of an entity evaluated during a Test Suite Run that is of type ERROR

func (*TestSuiteRunExecutionErrorOutput) String added in v0.3.13 

func (t *TestSuiteRunExecutionErrorOutput) String() string

func (*TestSuiteRunExecutionErrorOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecutionErrorOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionFunctionCallOutput added in v0.4.0 

type TestSuiteRunExecutionFunctionCallOutput struct {
	Name             string        `json:"name"`
	Value            *FunctionCall `json:"value,omitempty"`
	OutputVariableId string        `json:"output_variable_id"`
	// contains filtered or unexported fields
}

Execution output of an entity evaluated during a Test Suite Run that is of type FUNCTION_CALL

func (*TestSuiteRunExecutionFunctionCallOutput) String added in v0.4.0 

func (t *TestSuiteRunExecutionFunctionCallOutput) String() string

func (*TestSuiteRunExecutionFunctionCallOutput) UnmarshalJSON added in v0.4.0 

func (t *TestSuiteRunExecutionFunctionCallOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionJsonOutput added in v0.3.13 

type TestSuiteRunExecutionJsonOutput struct {
	Name             string                 `json:"name"`
	Value            map[string]interface{} `json:"value,omitempty"`
	OutputVariableId string                 `json:"output_variable_id"`
	// contains filtered or unexported fields
}

Execution output of an entity evaluated during a Test Suite Run that is of type JSON

func (*TestSuiteRunExecutionJsonOutput) String added in v0.3.13 

func (t *TestSuiteRunExecutionJsonOutput) String() string

func (*TestSuiteRunExecutionJsonOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecutionJsonOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionMetricDefinition added in v0.3.22 

type TestSuiteRunExecutionMetricDefinition struct {
	Id    *string `json:"id,omitempty"`
	Label *string `json:"label,omitempty"`
	Name  *string `json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunExecutionMetricDefinition) String added in v0.3.22 

func (t *TestSuiteRunExecutionMetricDefinition) String() string

func (*TestSuiteRunExecutionMetricDefinition) UnmarshalJSON added in v0.3.22 

func (t *TestSuiteRunExecutionMetricDefinition) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionMetricResult added in v0.3.13 

type TestSuiteRunExecutionMetricResult struct {
	MetricId         string                                 `json:"metric_id"`
	Outputs          []*TestSuiteRunMetricOutput            `json:"outputs,omitempty"`
	MetricLabel      *string                                `json:"metric_label,omitempty"`
	MetricDefinition *TestSuiteRunExecutionMetricDefinition `json:"metric_definition,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunExecutionMetricResult) String added in v0.3.13 

func (t *TestSuiteRunExecutionMetricResult) String() string

func (*TestSuiteRunExecutionMetricResult) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecutionMetricResult) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionNumberOutput added in v0.3.13 

type TestSuiteRunExecutionNumberOutput struct {
	Name             string   `json:"name"`
	Value            *float64 `json:"value,omitempty"`
	OutputVariableId string   `json:"output_variable_id"`
	// contains filtered or unexported fields
}

Execution output of an entity evaluated during a Test Suite Run that is of type NUMBER

func (*TestSuiteRunExecutionNumberOutput) String added in v0.3.13 

func (t *TestSuiteRunExecutionNumberOutput) String() string

func (*TestSuiteRunExecutionNumberOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecutionNumberOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionOutput added in v0.3.13 

type TestSuiteRunExecutionOutput struct {
	Type          string
	String        *TestSuiteRunExecutionStringOutput
	Number        *TestSuiteRunExecutionNumberOutput
	Json          *TestSuiteRunExecutionJsonOutput
	ChatHistory   *TestSuiteRunExecutionChatHistoryOutput
	SearchResults *TestSuiteRunExecutionSearchResultsOutput
	Error         *TestSuiteRunExecutionErrorOutput
	FunctionCall  *TestSuiteRunExecutionFunctionCallOutput
}

func NewTestSuiteRunExecutionOutputFromChatHistory added in v0.3.13 

func NewTestSuiteRunExecutionOutputFromChatHistory(value *TestSuiteRunExecutionChatHistoryOutput) *TestSuiteRunExecutionOutput

func NewTestSuiteRunExecutionOutputFromError added in v0.3.13 

func NewTestSuiteRunExecutionOutputFromError(value *TestSuiteRunExecutionErrorOutput) *TestSuiteRunExecutionOutput

func NewTestSuiteRunExecutionOutputFromFunctionCall added in v0.4.0 

func NewTestSuiteRunExecutionOutputFromFunctionCall(value *TestSuiteRunExecutionFunctionCallOutput) *TestSuiteRunExecutionOutput

func NewTestSuiteRunExecutionOutputFromJson added in v0.3.13 

func NewTestSuiteRunExecutionOutputFromJson(value *TestSuiteRunExecutionJsonOutput) *TestSuiteRunExecutionOutput

func NewTestSuiteRunExecutionOutputFromNumber added in v0.3.13 

func NewTestSuiteRunExecutionOutputFromNumber(value *TestSuiteRunExecutionNumberOutput) *TestSuiteRunExecutionOutput

func NewTestSuiteRunExecutionOutputFromSearchResults added in v0.3.13 

func NewTestSuiteRunExecutionOutputFromSearchResults(value *TestSuiteRunExecutionSearchResultsOutput) *TestSuiteRunExecutionOutput

func NewTestSuiteRunExecutionOutputFromString added in v0.3.13 

func NewTestSuiteRunExecutionOutputFromString(value *TestSuiteRunExecutionStringOutput) *TestSuiteRunExecutionOutput

func (*TestSuiteRunExecutionOutput) Accept added in v0.3.13 

func (t *TestSuiteRunExecutionOutput) Accept(visitor TestSuiteRunExecutionOutputVisitor) error

func (TestSuiteRunExecutionOutput) MarshalJSON added in v0.3.13 

func (t TestSuiteRunExecutionOutput) MarshalJSON() ([]byte, error)

func (*TestSuiteRunExecutionOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecutionOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionOutputVisitor added in v0.3.13 

type TestSuiteRunExecutionOutputVisitor interface {
	VisitString(*TestSuiteRunExecutionStringOutput) error
	VisitNumber(*TestSuiteRunExecutionNumberOutput) error
	VisitJson(*TestSuiteRunExecutionJsonOutput) error
	VisitChatHistory(*TestSuiteRunExecutionChatHistoryOutput) error
	VisitSearchResults(*TestSuiteRunExecutionSearchResultsOutput) error
	VisitError(*TestSuiteRunExecutionErrorOutput) error
	VisitFunctionCall(*TestSuiteRunExecutionFunctionCallOutput) error
}

type TestSuiteRunExecutionSearchResultsOutput added in v0.3.13 

type TestSuiteRunExecutionSearchResultsOutput struct {
	Name             string          `json:"name"`
	Value            []*SearchResult `json:"value,omitempty"`
	OutputVariableId string          `json:"output_variable_id"`
	// contains filtered or unexported fields
}

Execution output of an entity evaluated during a Test Suite Run that is of type SEARCH_RESULTS

func (*TestSuiteRunExecutionSearchResultsOutput) String added in v0.3.13 

func (t *TestSuiteRunExecutionSearchResultsOutput) String() string

func (*TestSuiteRunExecutionSearchResultsOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecutionSearchResultsOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunExecutionStringOutput added in v0.3.13 

type TestSuiteRunExecutionStringOutput struct {
	Name             string  `json:"name"`
	Value            *string `json:"value,omitempty"`
	OutputVariableId string  `json:"output_variable_id"`
	// contains filtered or unexported fields
}

Execution output of an entity evaluated during a Test Suite Run that is of type STRING

func (*TestSuiteRunExecutionStringOutput) String added in v0.3.13 

func (t *TestSuiteRunExecutionStringOutput) String() string

func (*TestSuiteRunExecutionStringOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunExecutionStringOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunExternalExecConfig added in v0.3.23 

type TestSuiteRunExternalExecConfig struct {
	Data *TestSuiteRunExternalExecConfigData `json:"data,omitempty"`
	// Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
	TestCaseIds []string `json:"test_case_ids,omitempty"`
	// contains filtered or unexported fields
}

Execution configuration for running a Vellum Test Suite against an external callable

func (*TestSuiteRunExternalExecConfig) String added in v0.3.23 

func (t *TestSuiteRunExternalExecConfig) String() string

func (*TestSuiteRunExternalExecConfig) UnmarshalJSON added in v0.3.23 

func (t *TestSuiteRunExternalExecConfig) UnmarshalJSON(data []byte) error

type TestSuiteRunExternalExecConfigData added in v0.3.23 

type TestSuiteRunExternalExecConfigData struct {
	// The executions of some callable external to Vellum whose outputs you would like to evaluate.
	Executions []*ExternalTestCaseExecution `json:"executions,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunExternalExecConfigData) String added in v0.3.23 

func (t *TestSuiteRunExternalExecConfigData) String() string

func (*TestSuiteRunExternalExecConfigData) UnmarshalJSON added in v0.3.23 

func (t *TestSuiteRunExternalExecConfigData) UnmarshalJSON(data []byte) error

type TestSuiteRunExternalExecConfigDataRequest added in v0.3.23 

type TestSuiteRunExternalExecConfigDataRequest struct {
	// The executions of some callable external to Vellum whose outputs you would like to evaluate.
	Executions []*ExternalTestCaseExecutionRequest `json:"executions,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunExternalExecConfigDataRequest) String added in v0.3.23 

func (t *TestSuiteRunExternalExecConfigDataRequest) String() string

func (*TestSuiteRunExternalExecConfigDataRequest) UnmarshalJSON added in v0.3.23 

func (t *TestSuiteRunExternalExecConfigDataRequest) UnmarshalJSON(data []byte) error

type TestSuiteRunExternalExecConfigRequest added in v0.3.23 

type TestSuiteRunExternalExecConfigRequest struct {
	Data *TestSuiteRunExternalExecConfigDataRequest `json:"data,omitempty"`
	// Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
	TestCaseIds []string `json:"test_case_ids,omitempty"`
	// contains filtered or unexported fields
}

Execution configuration for running a Vellum Test Suite against an external callable

func (*TestSuiteRunExternalExecConfigRequest) String added in v0.3.23 

func (t *TestSuiteRunExternalExecConfigRequest) String() string

func (*TestSuiteRunExternalExecConfigRequest) UnmarshalJSON added in v0.3.23 

func (t *TestSuiteRunExternalExecConfigRequest) UnmarshalJSON(data []byte) error

type TestSuiteRunExternalExecConfigTypeEnum added in v0.3.23 

type TestSuiteRunExternalExecConfigTypeEnum = string

- `EXTERNAL` - EXTERNAL

type TestSuiteRunMetricErrorOutput added in v0.3.13 

type TestSuiteRunMetricErrorOutput struct {
	Value *VellumError `json:"value,omitempty"`
	Name  string       `json:"name"`
	// contains filtered or unexported fields
}

Output for a test suite run metric that is of type ERROR

func (*TestSuiteRunMetricErrorOutput) String added in v0.3.13 

func (t *TestSuiteRunMetricErrorOutput) String() string

func (*TestSuiteRunMetricErrorOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunMetricErrorOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunMetricErrorOutputTypeEnum added in v0.3.13 

type TestSuiteRunMetricErrorOutputTypeEnum = string

- `ERROR` - ERROR

type TestSuiteRunMetricNumberOutput added in v0.3.13 

type TestSuiteRunMetricNumberOutput struct {
	Value float64 `json:"value"`
	Name  string  `json:"name"`
	// contains filtered or unexported fields
}

Output for a test suite run metric that is of type NUMBER

func (*TestSuiteRunMetricNumberOutput) String added in v0.3.13 

func (t *TestSuiteRunMetricNumberOutput) String() string

func (*TestSuiteRunMetricNumberOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunMetricNumberOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunMetricNumberOutputTypeEnum added in v0.3.13 

type TestSuiteRunMetricNumberOutputTypeEnum = string

- `NUMBER` - NUMBER

type TestSuiteRunMetricOutput added in v0.3.13 

type TestSuiteRunMetricOutput struct {
	Type   string
	String *TestSuiteRunMetricStringOutput
	Number *TestSuiteRunMetricNumberOutput
	Error  *TestSuiteRunMetricErrorOutput
}

func NewTestSuiteRunMetricOutputFromError added in v0.3.13 

func NewTestSuiteRunMetricOutputFromError(value *TestSuiteRunMetricErrorOutput) *TestSuiteRunMetricOutput

func NewTestSuiteRunMetricOutputFromNumber added in v0.3.13 

func NewTestSuiteRunMetricOutputFromNumber(value *TestSuiteRunMetricNumberOutput) *TestSuiteRunMetricOutput

func NewTestSuiteRunMetricOutputFromString added in v0.3.20 

func NewTestSuiteRunMetricOutputFromString(value *TestSuiteRunMetricStringOutput) *TestSuiteRunMetricOutput

func (*TestSuiteRunMetricOutput) Accept added in v0.3.13 

func (t *TestSuiteRunMetricOutput) Accept(visitor TestSuiteRunMetricOutputVisitor) error

func (TestSuiteRunMetricOutput) MarshalJSON added in v0.3.13 

func (t TestSuiteRunMetricOutput) MarshalJSON() ([]byte, error)

func (*TestSuiteRunMetricOutput) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunMetricOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunMetricOutputVisitor added in v0.3.13 

type TestSuiteRunMetricOutputVisitor interface {
	VisitString(*TestSuiteRunMetricStringOutput) error
	VisitNumber(*TestSuiteRunMetricNumberOutput) error
	VisitError(*TestSuiteRunMetricErrorOutput) error
}

type TestSuiteRunMetricStringOutput added in v0.3.20 

type TestSuiteRunMetricStringOutput struct {
	Value string `json:"value"`
	Name  string `json:"name"`
	// contains filtered or unexported fields
}

Output for a test suite run metric that is of type STRING

func (*TestSuiteRunMetricStringOutput) String added in v0.3.20 

func (t *TestSuiteRunMetricStringOutput) String() string

func (*TestSuiteRunMetricStringOutput) UnmarshalJSON added in v0.3.20 

func (t *TestSuiteRunMetricStringOutput) UnmarshalJSON(data []byte) error

type TestSuiteRunMetricStringOutputTypeEnum added in v0.3.20 

type TestSuiteRunMetricStringOutputTypeEnum = string

- `STRING` - STRING

type TestSuiteRunRead added in v0.3.13 

type TestSuiteRunRead struct {
	Id        string                 `json:"id"`
	Created   time.Time              `json:"created"`
	TestSuite *TestSuiteRunTestSuite `json:"test_suite,omitempty"`
	// The current state of this run
	//
	// - `QUEUED` - Queued
	// - `RUNNING` - Running
	// - `COMPLETE` - Complete
	// - `FAILED` - Failed
	// - `CANCELLED` - Cancelled
	State TestSuiteRunState `json:"state,omitempty"`
	// Configuration that defines how the Test Suite should be run
	ExecConfig *TestSuiteRunExecConfig `json:"exec_config,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunRead) String added in v0.3.13 

func (t *TestSuiteRunRead) String() string

func (*TestSuiteRunRead) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunRead) UnmarshalJSON(data []byte) error

type TestSuiteRunState added in v0.3.13 

type TestSuiteRunState string

- `QUEUED` - Queued - `RUNNING` - Running - `COMPLETE` - Complete - `FAILED` - Failed - `CANCELLED` - Cancelled 

const (
	TestSuiteRunStateQueued    TestSuiteRunState = "QUEUED"
	TestSuiteRunStateRunning   TestSuiteRunState = "RUNNING"
	TestSuiteRunStateComplete  TestSuiteRunState = "COMPLETE"
	TestSuiteRunStateFailed    TestSuiteRunState = "FAILED"
	TestSuiteRunStateCancelled TestSuiteRunState = "CANCELLED"
)

func NewTestSuiteRunStateFromString added in v0.3.13 

func NewTestSuiteRunStateFromString(s string) (TestSuiteRunState, error)

func (TestSuiteRunState) Ptr added in v0.3.13 

func (t TestSuiteRunState) Ptr() *TestSuiteRunState

type TestSuiteRunTestSuite added in v0.3.13 

type TestSuiteRunTestSuite struct {
	Id            string `json:"id"`
	HistoryItemId string `json:"history_item_id"`
	Label         string `json:"label"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunTestSuite) String added in v0.3.13 

func (t *TestSuiteRunTestSuite) String() string

func (*TestSuiteRunTestSuite) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunTestSuite) UnmarshalJSON(data []byte) error

type TestSuiteRunWorkflowReleaseTagExecConfig added in v0.3.13 

type TestSuiteRunWorkflowReleaseTagExecConfig struct {
	Data *TestSuiteRunWorkflowReleaseTagExecConfigData `json:"data,omitempty"`
	// Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
	TestCaseIds []string `json:"test_case_ids,omitempty"`
	// contains filtered or unexported fields
}

Execution configuration for running a Test Suite against a Workflow Deployment

func (*TestSuiteRunWorkflowReleaseTagExecConfig) String added in v0.3.13 

func (t *TestSuiteRunWorkflowReleaseTagExecConfig) String() string

func (*TestSuiteRunWorkflowReleaseTagExecConfig) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunWorkflowReleaseTagExecConfig) UnmarshalJSON(data []byte) error

type TestSuiteRunWorkflowReleaseTagExecConfigData added in v0.3.13 

type TestSuiteRunWorkflowReleaseTagExecConfigData struct {
	// The ID of the Workflow Deployment to run the Test Suite against.
	WorkflowDeploymentId string `json:"workflow_deployment_id"`
	// A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment
	Tag *string `json:"tag,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunWorkflowReleaseTagExecConfigData) String added in v0.3.13 

func (t *TestSuiteRunWorkflowReleaseTagExecConfigData) String() string

func (*TestSuiteRunWorkflowReleaseTagExecConfigData) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunWorkflowReleaseTagExecConfigData) UnmarshalJSON(data []byte) error

type TestSuiteRunWorkflowReleaseTagExecConfigDataRequest added in v0.3.13 

type TestSuiteRunWorkflowReleaseTagExecConfigDataRequest struct {
	// The ID of the Workflow Deployment to run the Test Suite against.
	WorkflowDeploymentId string `json:"workflow_deployment_id"`
	// A tag identifying which release of the Workflow Deployment to run the Test Suite against. Useful for testing past versions of the Workflow Deployment
	Tag *string `json:"tag,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteRunWorkflowReleaseTagExecConfigDataRequest) String added in v0.3.13 

func (t *TestSuiteRunWorkflowReleaseTagExecConfigDataRequest) String() string

func (*TestSuiteRunWorkflowReleaseTagExecConfigDataRequest) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunWorkflowReleaseTagExecConfigDataRequest) UnmarshalJSON(data []byte) error

type TestSuiteRunWorkflowReleaseTagExecConfigRequest added in v0.3.13 

type TestSuiteRunWorkflowReleaseTagExecConfigRequest struct {
	Data *TestSuiteRunWorkflowReleaseTagExecConfigDataRequest `json:"data,omitempty"`
	// Optionally specify a subset of test case ids to run. If not provided, all test cases within the test suite will be run by default.
	TestCaseIds []string `json:"test_case_ids,omitempty"`
	// contains filtered or unexported fields
}

Execution configuration for running a Test Suite against a Workflow Deployment

func (*TestSuiteRunWorkflowReleaseTagExecConfigRequest) String added in v0.3.13 

func (t *TestSuiteRunWorkflowReleaseTagExecConfigRequest) String() string

func (*TestSuiteRunWorkflowReleaseTagExecConfigRequest) UnmarshalJSON added in v0.3.13 

func (t *TestSuiteRunWorkflowReleaseTagExecConfigRequest) UnmarshalJSON(data []byte) error

type TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum added in v0.3.13 

type TestSuiteRunWorkflowReleaseTagExecConfigTypeEnum = string

- `WORKFLOW_RELEASE_TAG` - WORKFLOW_RELEASE_TAG

type TestSuiteRunsListExecutionsRequest added in v0.3.15 

type TestSuiteRunsListExecutionsRequest struct {
	// The response fields to expand for more information.
	//
	// - 'results.metric_results.metric_label' expands the metric label for each metric result.
	// - 'results.metric_results.metric_definition' expands the metric definition for each metric result.
	// - 'results.metric_results.metric_definition.name' expands the metric definition name for each metric result.
	Expand []*string `json:"-"`
	// Number of results to return per page.
	Limit *int `json:"-"`
	// The initial index from which to return the results.
	Offset *int `json:"-"`
}

type TestSuiteTestCase 

type TestSuiteTestCase struct {
	Id               *string                  `json:"id,omitempty"`
	Label            *string                  `json:"label,omitempty"`
	InputValues      []*TestCaseVariableValue `json:"input_values,omitempty"`
	EvaluationValues []*TestCaseVariableValue `json:"evaluation_values,omitempty"`
	// contains filtered or unexported fields
}

func (*TestSuiteTestCase) String 

func (t *TestSuiteTestCase) String() string

func (*TestSuiteTestCase) UnmarshalJSON 

func (t *TestSuiteTestCase) UnmarshalJSON(data []byte) error

type TextEmbedding3LargeEnum added in v0.6.0 

type TextEmbedding3LargeEnum = string

type TextEmbedding3SmallEnum added in v0.6.0 

type TextEmbedding3SmallEnum = string

type TextEmbeddingAda002Enum added in v0.6.0 

type TextEmbeddingAda002Enum = string

type TokenOverlappingWindowChunkerConfig added in v0.6.0 

type TokenOverlappingWindowChunkerConfig struct {
	TokenLimit   *int     `json:"token_limit,omitempty"`
	OverlapRatio *float64 `json:"overlap_ratio,omitempty"`
	// contains filtered or unexported fields
}

Configuration for token overlapping window chunking

func (*TokenOverlappingWindowChunkerConfig) String added in v0.6.0 

func (t *TokenOverlappingWindowChunkerConfig) String() string

func (*TokenOverlappingWindowChunkerConfig) UnmarshalJSON added in v0.6.0 

func (t *TokenOverlappingWindowChunkerConfig) UnmarshalJSON(data []byte) error

type TokenOverlappingWindowChunkerConfigRequest added in v0.6.0 

type TokenOverlappingWindowChunkerConfigRequest struct {
	TokenLimit   *int     `json:"token_limit,omitempty"`
	OverlapRatio *float64 `json:"overlap_ratio,omitempty"`
	// contains filtered or unexported fields
}

Configuration for token overlapping window chunking

func (*TokenOverlappingWindowChunkerConfigRequest) String added in v0.6.0 

func (t *TokenOverlappingWindowChunkerConfigRequest) String() string

func (*TokenOverlappingWindowChunkerConfigRequest) UnmarshalJSON added in v0.6.0 

func (t *TokenOverlappingWindowChunkerConfigRequest) UnmarshalJSON(data []byte) error

type TokenOverlappingWindowChunkerEnum added in v0.6.0 

type TokenOverlappingWindowChunkerEnum = string

type TokenOverlappingWindowChunking added in v0.6.0 

type TokenOverlappingWindowChunking struct {
	ChunkerConfig *TokenOverlappingWindowChunkerConfig `json:"chunker_config,omitempty"`
	// contains filtered or unexported fields
}

Token overlapping window chunking

func (*TokenOverlappingWindowChunking) String added in v0.6.0 

func (t *TokenOverlappingWindowChunking) String() string

func (*TokenOverlappingWindowChunking) UnmarshalJSON added in v0.6.0 

func (t *TokenOverlappingWindowChunking) UnmarshalJSON(data []byte) error

type TokenOverlappingWindowChunkingRequest added in v0.6.0 

type TokenOverlappingWindowChunkingRequest struct {
	ChunkerConfig *TokenOverlappingWindowChunkerConfigRequest `json:"chunker_config,omitempty"`
	// contains filtered or unexported fields
}

Token overlapping window chunking

func (*TokenOverlappingWindowChunkingRequest) String added in v0.6.0 

func (t *TokenOverlappingWindowChunkingRequest) String() string

func (*TokenOverlappingWindowChunkingRequest) UnmarshalJSON added in v0.6.0 

func (t *TokenOverlappingWindowChunkingRequest) UnmarshalJSON(data []byte) error

type UploadDocumentBodyRequest 

type UploadDocumentBodyRequest struct {
	// Optionally include the names of all indexes that you'd like this document to be included in
	AddToIndexNames []string `json:"add_to_index_names,omitempty"`
	// Optionally include an external ID for this document. This is useful if you want to re-upload the same document later when its contents change and would like it to be re-indexed.
	ExternalId *string `json:"external_id,omitempty"`
	// A human-friendly name for this document. Typically the filename.
	Label string `json:"label"`
	// Optionally include a list of keywords that'll be associated with this document. Used when performing keyword searches.
	Keywords []string `json:"keywords,omitempty"`
	// A stringified JSON object containing any metadata associated with the document that you'd like to filter upon later.
	Metadata *string `json:"metadata,omitempty"`
}

type UploadDocumentErrorResponse 

type UploadDocumentErrorResponse struct {
	Detail string `json:"detail"`
	// contains filtered or unexported fields
}

func (*UploadDocumentErrorResponse) String 

func (u *UploadDocumentErrorResponse) String() string

func (*UploadDocumentErrorResponse) UnmarshalJSON 

func (u *UploadDocumentErrorResponse) UnmarshalJSON(data []byte) error

type UploadDocumentResponse 

type UploadDocumentResponse struct {
	// The ID of the newly created document.
	DocumentId string `json:"document_id"`
	// contains filtered or unexported fields
}

func (*UploadDocumentResponse) String 

func (u *UploadDocumentResponse) String() string

func (*UploadDocumentResponse) UnmarshalJSON 

func (u *UploadDocumentResponse) UnmarshalJSON(data []byte) error

type UpsertSandboxScenarioRequestRequest 

type UpsertSandboxScenarioRequestRequest struct {
	Label *string `json:"label,omitempty"`
	// The inputs for the scenario
	Inputs []*NamedScenarioInputRequest `json:"inputs,omitempty"`
	// The id of the scenario to update. If none is provided, an id will be generated and a new scenario will be appended.
	ScenarioId *string `json:"scenario_id,omitempty"`
}

type UpsertTestSuiteTestCaseRequest 

type UpsertTestSuiteTestCaseRequest struct {
	UpsertTestSuiteTestCaseRequestId *string                              `json:"id,omitempty"`
	Label                            *string                              `json:"label,omitempty"`
	InputValues                      []*NamedTestCaseVariableValueRequest `json:"input_values,omitempty"`
	EvaluationValues                 []*NamedTestCaseVariableValueRequest `json:"evaluation_values,omitempty"`
}

type VellumError 

type VellumError struct {
	Message string              `json:"message"`
	Code    VellumErrorCodeEnum `json:"code,omitempty"`
	// contains filtered or unexported fields
}

func (*VellumError) String 

func (v *VellumError) String() string

func (*VellumError) UnmarshalJSON 

func (v *VellumError) UnmarshalJSON(data []byte) error

type VellumErrorCodeEnum 

type VellumErrorCodeEnum string

- `INVALID_REQUEST` - INVALID_REQUEST - `PROVIDER_ERROR` - PROVIDER_ERROR - `INTERNAL_SERVER_ERROR` - INTERNAL_SERVER_ERROR - `USER_DEFINED_ERROR` - USER_DEFINED_ERROR 

const (
	VellumErrorCodeEnumInvalidRequest      VellumErrorCodeEnum = "INVALID_REQUEST"
	VellumErrorCodeEnumProviderError       VellumErrorCodeEnum = "PROVIDER_ERROR"
	VellumErrorCodeEnumInternalServerError VellumErrorCodeEnum = "INTERNAL_SERVER_ERROR"
	VellumErrorCodeEnumUserDefinedError    VellumErrorCodeEnum = "USER_DEFINED_ERROR"
)

func NewVellumErrorCodeEnumFromString 

func NewVellumErrorCodeEnumFromString(s string) (VellumErrorCodeEnum, error)

func (VellumErrorCodeEnum) Ptr 

func (v VellumErrorCodeEnum) Ptr() *VellumErrorCodeEnum

type VellumErrorRequest 

type VellumErrorRequest struct {
	Message string              `json:"message"`
	Code    VellumErrorCodeEnum `json:"code,omitempty"`
	// contains filtered or unexported fields
}

func (*VellumErrorRequest) String 

func (v *VellumErrorRequest) String() string

func (*VellumErrorRequest) UnmarshalJSON 

func (v *VellumErrorRequest) UnmarshalJSON(data []byte) error

type VellumImage added in v0.2.0 

type VellumImage struct {
	Src      string                 `json:"src"`
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*VellumImage) String added in v0.2.0 

func (v *VellumImage) String() string

func (*VellumImage) UnmarshalJSON added in v0.2.0 

func (v *VellumImage) UnmarshalJSON(data []byte) error

type VellumImageRequest added in v0.2.0 

type VellumImageRequest struct {
	Src      string                 `json:"src"`
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*VellumImageRequest) String added in v0.2.0 

func (v *VellumImageRequest) String() string

func (*VellumImageRequest) UnmarshalJSON added in v0.2.0 

func (v *VellumImageRequest) UnmarshalJSON(data []byte) error

type VellumVariable 

type VellumVariable struct {
	Id   string             `json:"id"`
	Key  string             `json:"key"`
	Type VellumVariableType `json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*VellumVariable) String 

func (v *VellumVariable) String() string

func (*VellumVariable) UnmarshalJSON 

func (v *VellumVariable) UnmarshalJSON(data []byte) error

type VellumVariableType 

type VellumVariableType string

- `STRING` - STRING - `NUMBER` - NUMBER - `JSON` - JSON - `CHAT_HISTORY` - CHAT_HISTORY - `SEARCH_RESULTS` - SEARCH_RESULTS - `ERROR` - ERROR - `ARRAY` - ARRAY - `FUNCTION_CALL` - FUNCTION_CALL - `IMAGE` - IMAGE - `NULL` - NULL 

const (
	VellumVariableTypeString        VellumVariableType = "STRING"
	VellumVariableTypeNumber        VellumVariableType = "NUMBER"
	VellumVariableTypeJson          VellumVariableType = "JSON"
	VellumVariableTypeChatHistory   VellumVariableType = "CHAT_HISTORY"
	VellumVariableTypeSearchResults VellumVariableType = "SEARCH_RESULTS"
	VellumVariableTypeError         VellumVariableType = "ERROR"
	VellumVariableTypeArray         VellumVariableType = "ARRAY"
	VellumVariableTypeFunctionCall  VellumVariableType = "FUNCTION_CALL"
	VellumVariableTypeImage         VellumVariableType = "IMAGE"
	VellumVariableTypeNull          VellumVariableType = "NULL"
)

func NewVellumVariableTypeFromString 

func NewVellumVariableTypeFromString(s string) (VellumVariableType, error)

func (VellumVariableType) Ptr 

func (v VellumVariableType) Ptr() *VellumVariableType

type WorkflowDeploymentRead added in v0.3.8 

type WorkflowDeploymentRead struct {
	Id string `json:"id"`
	// A name that uniquely identifies this workflow deployment within its workspace
	Name string `json:"name"`
	// A human-readable label for the workflow deployment
	Label string `json:"label"`
	// The current status of the workflow deployment
	//
	// - `ACTIVE` - Active
	// - `ARCHIVED` - Archived
	Status *EntityStatus `json:"status,omitempty"`
	// The environment this workflow deployment is used in
	//
	// - `DEVELOPMENT` - Development
	// - `STAGING` - Staging
	// - `PRODUCTION` - Production
	Environment    *EnvironmentEnum `json:"environment,omitempty"`
	Created        time.Time        `json:"created"`
	LastDeployedOn time.Time        `json:"last_deployed_on"`
	// The input variables this Workflow Deployment expects to receive values for when it is executed.
	InputVariables []*VellumVariable `json:"input_variables,omitempty"`
	// The output variables this Workflow Deployment produces values for when it's executed.
	OutputVariables []*VellumVariable `json:"output_variables,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkflowDeploymentRead) String added in v0.3.8 

func (w *WorkflowDeploymentRead) String() string

func (*WorkflowDeploymentRead) UnmarshalJSON added in v0.3.8 

func (w *WorkflowDeploymentRead) UnmarshalJSON(data []byte) error

type WorkflowDeploymentsListRequest added in v0.2.0 

type WorkflowDeploymentsListRequest struct {
	// Number of results to return per page.
	Limit *int `json:"-"`
	// The initial index from which to return the results.
	Offset *int `json:"-"`
	// Which field to use when ordering the results.
	Ordering *string `json:"-"`
	// status
	Status *WorkflowDeploymentsListRequestStatus `json:"-"`
}

type WorkflowDeploymentsListRequestStatus added in v0.2.0 

type WorkflowDeploymentsListRequestStatus string
const (
	WorkflowDeploymentsListRequestStatusActive   WorkflowDeploymentsListRequestStatus = "ACTIVE"
	WorkflowDeploymentsListRequestStatusArchived WorkflowDeploymentsListRequestStatus = "ARCHIVED"
)

func NewWorkflowDeploymentsListRequestStatusFromString added in v0.2.0 

func NewWorkflowDeploymentsListRequestStatusFromString(s string) (WorkflowDeploymentsListRequestStatus, error)

func (WorkflowDeploymentsListRequestStatus) Ptr added in v0.2.0 

func (w WorkflowDeploymentsListRequestStatus) Ptr() *WorkflowDeploymentsListRequestStatus

type WorkflowEventError 

type WorkflowEventError struct {
	Message string                          `json:"message"`
	Code    WorkflowExecutionEventErrorCode `json:"code,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkflowEventError) String 

func (w *WorkflowEventError) String() string

func (*WorkflowEventError) UnmarshalJSON 

func (w *WorkflowEventError) UnmarshalJSON(data []byte) error

type WorkflowExecutionActualChatHistoryRequest 

type WorkflowExecutionActualChatHistoryRequest struct {
	// The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred.
	OutputId *string `json:"output_id,omitempty"`
	// The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id.
	OutputKey *string `json:"output_key,omitempty"`
	// Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best.
	Quality *float64 `json:"quality,omitempty"`
	// Optionally provide additional metadata about the feedback submission.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes.
	Timestamp *float64 `json:"timestamp,omitempty"`
	// Optionally provide the value that the output ideally should have been.
	DesiredOutputValue []*ChatMessageRequest `json:"desired_output_value,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkflowExecutionActualChatHistoryRequest) String 

func (w *WorkflowExecutionActualChatHistoryRequest) String() string

func (*WorkflowExecutionActualChatHistoryRequest) UnmarshalJSON 

func (w *WorkflowExecutionActualChatHistoryRequest) UnmarshalJSON(data []byte) error

type WorkflowExecutionActualJsonRequest 

type WorkflowExecutionActualJsonRequest struct {
	// The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred.
	OutputId *string `json:"output_id,omitempty"`
	// The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id.
	OutputKey *string `json:"output_key,omitempty"`
	// Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best.
	Quality *float64 `json:"quality,omitempty"`
	// Optionally provide additional metadata about the feedback submission.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes.
	Timestamp *float64 `json:"timestamp,omitempty"`
	// Optionally provide the value that the output ideally should have been.
	DesiredOutputValue map[string]interface{} `json:"desired_output_value,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkflowExecutionActualJsonRequest) String 

func (w *WorkflowExecutionActualJsonRequest) String() string

func (*WorkflowExecutionActualJsonRequest) UnmarshalJSON 

func (w *WorkflowExecutionActualJsonRequest) UnmarshalJSON(data []byte) error

type WorkflowExecutionActualStringRequest 

type WorkflowExecutionActualStringRequest struct {
	// The Vellum-generated ID of a workflow output. Must provide either this or output_key. output_key is typically preferred.
	OutputId *string `json:"output_id,omitempty"`
	// The user-defined name of a workflow output. Must provide either this or output_id. Should correspond to the `Name` specified in a Final Output Node. Generally preferred over output_id.
	OutputKey *string `json:"output_key,omitempty"`
	// Optionally provide a decimal number between 0.0 and 1.0 (inclusive) representing the quality of the output. 0 is the worst, 1 is the best.
	Quality *float64 `json:"quality,omitempty"`
	// Optionally provide additional metadata about the feedback submission.
	Metadata map[string]interface{} `json:"metadata,omitempty"`
	// Optionally provide the timestamp representing when this feedback was collected. Used for reporting purposes.
	Timestamp *float64 `json:"timestamp,omitempty"`
	// Optionally provide the value that the output ideally should have been.
	DesiredOutputValue *string `json:"desired_output_value,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkflowExecutionActualStringRequest) String 

func (w *WorkflowExecutionActualStringRequest) String() string

func (*WorkflowExecutionActualStringRequest) UnmarshalJSON 

func (w *WorkflowExecutionActualStringRequest) UnmarshalJSON(data []byte) error

type WorkflowExecutionEventErrorCode 

type WorkflowExecutionEventErrorCode string

- `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 

const (
	WorkflowExecutionEventErrorCodeWorkflowInitialization         WorkflowExecutionEventErrorCode = "WORKFLOW_INITIALIZATION"
	WorkflowExecutionEventErrorCodeWorkflowCancelled              WorkflowExecutionEventErrorCode = "WORKFLOW_CANCELLED"
	WorkflowExecutionEventErrorCodeNodeExecutionCountLimitReached WorkflowExecutionEventErrorCode = "NODE_EXECUTION_COUNT_LIMIT_REACHED"
	WorkflowExecutionEventErrorCodeInternalServerError            WorkflowExecutionEventErrorCode = "INTERNAL_SERVER_ERROR"
	WorkflowExecutionEventErrorCodeNodeExecution                  WorkflowExecutionEventErrorCode = "NODE_EXECUTION"
	WorkflowExecutionEventErrorCodeLlmProvider                    WorkflowExecutionEventErrorCode = "LLM_PROVIDER"
	WorkflowExecutionEventErrorCodeInvalidTemplate                WorkflowExecutionEventErrorCode = "INVALID_TEMPLATE"
	WorkflowExecutionEventErrorCodeUserDefinedError               WorkflowExecutionEventErrorCode = "USER_DEFINED_ERROR"
)

func NewWorkflowExecutionEventErrorCodeFromString 

func NewWorkflowExecutionEventErrorCodeFromString(s string) (WorkflowExecutionEventErrorCode, error)

func (WorkflowExecutionEventErrorCode) Ptr 

func (w WorkflowExecutionEventErrorCode) Ptr() *WorkflowExecutionEventErrorCode

type WorkflowExecutionEventType 

type WorkflowExecutionEventType string

- `NODE` - NODE - `WORKFLOW` - WORKFLOW 

const (
	WorkflowExecutionEventTypeNode     WorkflowExecutionEventType = "NODE"
	WorkflowExecutionEventTypeWorkflow WorkflowExecutionEventType = "WORKFLOW"
)

func NewWorkflowExecutionEventTypeFromString 

func NewWorkflowExecutionEventTypeFromString(s string) (WorkflowExecutionEventType, error)

func (WorkflowExecutionEventType) Ptr 

func (w WorkflowExecutionEventType) Ptr() *WorkflowExecutionEventType

type WorkflowExecutionNodeResultEvent 

type WorkflowExecutionNodeResultEvent struct {
	ExecutionId string                   `json:"execution_id"`
	RunId       *string                  `json:"run_id,omitempty"`
	ExternalId  *string                  `json:"external_id,omitempty"`
	Data        *WorkflowNodeResultEvent `json:"data,omitempty"`
	// contains filtered or unexported fields
}

A NODE-level event emitted from the workflow's execution.

func (*WorkflowExecutionNodeResultEvent) String 

func (w *WorkflowExecutionNodeResultEvent) String() string

func (*WorkflowExecutionNodeResultEvent) UnmarshalJSON 

func (w *WorkflowExecutionNodeResultEvent) UnmarshalJSON(data []byte) error

type WorkflowExecutionWorkflowResultEvent 

type WorkflowExecutionWorkflowResultEvent struct {
	ExecutionId string               `json:"execution_id"`
	RunId       *string              `json:"run_id,omitempty"`
	ExternalId  *string              `json:"external_id,omitempty"`
	Data        *WorkflowResultEvent `json:"data,omitempty"`
	// contains filtered or unexported fields
}

A WORKFLOW-level event emitted from the workflow's execution.

func (*WorkflowExecutionWorkflowResultEvent) String 

func (w *WorkflowExecutionWorkflowResultEvent) String() string

func (*WorkflowExecutionWorkflowResultEvent) UnmarshalJSON 

func (w *WorkflowExecutionWorkflowResultEvent) UnmarshalJSON(data []byte) error

type WorkflowNodeResultData 

type WorkflowNodeResultData struct {
	Type          string
	Prompt        *PromptNodeResult
	Search        *SearchNodeResult
	Templating    *TemplatingNodeResult
	CodeExecution *CodeExecutionNodeResult
	Conditional   *ConditionalNodeResult
	Api           *ApiNodeResult
	Terminal      *TerminalNodeResult
	Merge         *MergeNodeResult
	Subworkflow   *SubworkflowNodeResult
	Metric        *MetricNodeResult
}

func NewWorkflowNodeResultDataFromApi 

func NewWorkflowNodeResultDataFromApi(value *ApiNodeResult) *WorkflowNodeResultData

func NewWorkflowNodeResultDataFromCodeExecution 

func NewWorkflowNodeResultDataFromCodeExecution(value *CodeExecutionNodeResult) *WorkflowNodeResultData

func NewWorkflowNodeResultDataFromConditional 

func NewWorkflowNodeResultDataFromConditional(value *ConditionalNodeResult) *WorkflowNodeResultData

func NewWorkflowNodeResultDataFromMerge added in v0.6.1 

func NewWorkflowNodeResultDataFromMerge(value *MergeNodeResult) *WorkflowNodeResultData

func NewWorkflowNodeResultDataFromMetric added in v0.6.0 

func NewWorkflowNodeResultDataFromMetric(value *MetricNodeResult) *WorkflowNodeResultData

func NewWorkflowNodeResultDataFromPrompt 

func NewWorkflowNodeResultDataFromPrompt(value *PromptNodeResult) *WorkflowNodeResultData

func NewWorkflowNodeResultDataFromSearch 

func NewWorkflowNodeResultDataFromSearch(value *SearchNodeResult) *WorkflowNodeResultData

func NewWorkflowNodeResultDataFromSubworkflow added in v0.3.9 

func NewWorkflowNodeResultDataFromSubworkflow(value *SubworkflowNodeResult) *WorkflowNodeResultData

func NewWorkflowNodeResultDataFromTemplating 

func NewWorkflowNodeResultDataFromTemplating(value *TemplatingNodeResult) *WorkflowNodeResultData

func NewWorkflowNodeResultDataFromTerminal 

func NewWorkflowNodeResultDataFromTerminal(value *TerminalNodeResult) *WorkflowNodeResultData

func (*WorkflowNodeResultData) Accept 

func (w *WorkflowNodeResultData) Accept(visitor WorkflowNodeResultDataVisitor) error

func (WorkflowNodeResultData) MarshalJSON 

func (w WorkflowNodeResultData) MarshalJSON() ([]byte, error)

func (*WorkflowNodeResultData) UnmarshalJSON 

func (w *WorkflowNodeResultData) UnmarshalJSON(data []byte) error

type WorkflowNodeResultDataVisitor 

type WorkflowNodeResultDataVisitor interface {
	VisitPrompt(*PromptNodeResult) error
	VisitSearch(*SearchNodeResult) error
	VisitTemplating(*TemplatingNodeResult) error
	VisitCodeExecution(*CodeExecutionNodeResult) error
	VisitConditional(*ConditionalNodeResult) error
	VisitApi(*ApiNodeResult) error
	VisitTerminal(*TerminalNodeResult) error
	VisitMerge(*MergeNodeResult) error
	VisitSubworkflow(*SubworkflowNodeResult) error
	VisitMetric(*MetricNodeResult) error
}

type WorkflowNodeResultEvent 

type WorkflowNodeResultEvent struct {
	State     string
	Initiated *InitiatedWorkflowNodeResultEvent
	Streaming *StreamingWorkflowNodeResultEvent
	Fulfilled *FulfilledWorkflowNodeResultEvent
	Rejected  *RejectedWorkflowNodeResultEvent
}

func NewWorkflowNodeResultEventFromFulfilled added in v0.3.0 

func NewWorkflowNodeResultEventFromFulfilled(value *FulfilledWorkflowNodeResultEvent) *WorkflowNodeResultEvent

func NewWorkflowNodeResultEventFromInitiated added in v0.3.0 

func NewWorkflowNodeResultEventFromInitiated(value *InitiatedWorkflowNodeResultEvent) *WorkflowNodeResultEvent

func NewWorkflowNodeResultEventFromRejected added in v0.3.0 

func NewWorkflowNodeResultEventFromRejected(value *RejectedWorkflowNodeResultEvent) *WorkflowNodeResultEvent

func NewWorkflowNodeResultEventFromStreaming added in v0.3.0 

func NewWorkflowNodeResultEventFromStreaming(value *StreamingWorkflowNodeResultEvent) *WorkflowNodeResultEvent

func (*WorkflowNodeResultEvent) Accept added in v0.3.0 

func (w *WorkflowNodeResultEvent) Accept(visitor WorkflowNodeResultEventVisitor) error

func (WorkflowNodeResultEvent) MarshalJSON added in v0.3.0 

func (w WorkflowNodeResultEvent) MarshalJSON() ([]byte, error)

func (*WorkflowNodeResultEvent) UnmarshalJSON 

func (w *WorkflowNodeResultEvent) UnmarshalJSON(data []byte) error

type WorkflowNodeResultEventState 

type WorkflowNodeResultEventState string

- `INITIATED` - INITIATED - `STREAMING` - STREAMING - `FULFILLED` - FULFILLED - `REJECTED` - REJECTED 

const (
	WorkflowNodeResultEventStateInitiated WorkflowNodeResultEventState = "INITIATED"
	WorkflowNodeResultEventStateStreaming WorkflowNodeResultEventState = "STREAMING"
	WorkflowNodeResultEventStateFulfilled WorkflowNodeResultEventState = "FULFILLED"
	WorkflowNodeResultEventStateRejected  WorkflowNodeResultEventState = "REJECTED"
)

func NewWorkflowNodeResultEventStateFromString 

func NewWorkflowNodeResultEventStateFromString(s string) (WorkflowNodeResultEventState, error)

func (WorkflowNodeResultEventState) Ptr 

func (w WorkflowNodeResultEventState) Ptr() *WorkflowNodeResultEventState

type WorkflowNodeResultEventVisitor added in v0.3.0 

type WorkflowNodeResultEventVisitor interface {
	VisitInitiated(*InitiatedWorkflowNodeResultEvent) error
	VisitStreaming(*StreamingWorkflowNodeResultEvent) error
	VisitFulfilled(*FulfilledWorkflowNodeResultEvent) error
	VisitRejected(*RejectedWorkflowNodeResultEvent) error
}

type WorkflowOutput added in v0.2.1 

type WorkflowOutput struct {
	Type          string
	String        *WorkflowOutputString
	Number        *WorkflowOutputNumber
	Json          *WorkflowOutputJson
	ChatHistory   *WorkflowOutputChatHistory
	SearchResults *WorkflowOutputSearchResults
	Array         *WorkflowOutputArray
	Error         *WorkflowOutputError
	FunctionCall  *WorkflowOutputFunctionCall
	Image         *WorkflowOutputImage
}

func NewWorkflowOutputFromArray added in v0.2.1 

func NewWorkflowOutputFromArray(value *WorkflowOutputArray) *WorkflowOutput

func NewWorkflowOutputFromChatHistory added in v0.2.1 

func NewWorkflowOutputFromChatHistory(value *WorkflowOutputChatHistory) *WorkflowOutput

func NewWorkflowOutputFromError added in v0.2.1 

func NewWorkflowOutputFromError(value *WorkflowOutputError) *WorkflowOutput

func NewWorkflowOutputFromFunctionCall added in v0.2.1 

func NewWorkflowOutputFromFunctionCall(value *WorkflowOutputFunctionCall) *WorkflowOutput

func NewWorkflowOutputFromImage added in v0.2.1 

func NewWorkflowOutputFromImage(value *WorkflowOutputImage) *WorkflowOutput

func NewWorkflowOutputFromJson added in v0.2.1 

func NewWorkflowOutputFromJson(value *WorkflowOutputJson) *WorkflowOutput

func NewWorkflowOutputFromNumber added in v0.2.1 

func NewWorkflowOutputFromNumber(value *WorkflowOutputNumber) *WorkflowOutput

func NewWorkflowOutputFromSearchResults added in v0.2.1 

func NewWorkflowOutputFromSearchResults(value *WorkflowOutputSearchResults) *WorkflowOutput

func NewWorkflowOutputFromString added in v0.2.1 

func NewWorkflowOutputFromString(value *WorkflowOutputString) *WorkflowOutput

func (*WorkflowOutput) Accept added in v0.2.1 

func (w *WorkflowOutput) Accept(visitor WorkflowOutputVisitor) error

func (WorkflowOutput) MarshalJSON added in v0.2.1 

func (w WorkflowOutput) MarshalJSON() ([]byte, error)

func (*WorkflowOutput) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutput) UnmarshalJSON(data []byte) error

type WorkflowOutputArray added in v0.2.1 

type WorkflowOutputArray struct {
	Id string `json:"id"`
	// The output's name, as defined in the workflow
	Name  string                  `json:"name"`
	Value []*ArrayVellumValueItem `json:"value,omitempty"`
	// contains filtered or unexported fields
}

An array output from a Workflow execution.

func (*WorkflowOutputArray) String added in v0.2.1 

func (w *WorkflowOutputArray) String() string

func (*WorkflowOutputArray) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutputArray) UnmarshalJSON(data []byte) error

type WorkflowOutputChatHistory added in v0.2.1 

type WorkflowOutputChatHistory struct {
	Id string `json:"id"`
	// The output's name, as defined in the workflow
	Name  string         `json:"name"`
	Value []*ChatMessage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A chat history output from a Workflow execution.

func (*WorkflowOutputChatHistory) String added in v0.2.1 

func (w *WorkflowOutputChatHistory) String() string

func (*WorkflowOutputChatHistory) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutputChatHistory) UnmarshalJSON(data []byte) error

type WorkflowOutputError added in v0.2.1 

type WorkflowOutputError struct {
	Id string `json:"id"`
	// The output's name, as defined in the workflow
	Name  string       `json:"name"`
	Value *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

An error output from a Workflow execution.

func (*WorkflowOutputError) String added in v0.2.1 

func (w *WorkflowOutputError) String() string

func (*WorkflowOutputError) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutputError) UnmarshalJSON(data []byte) error

type WorkflowOutputFunctionCall added in v0.2.1 

type WorkflowOutputFunctionCall struct {
	Id string `json:"id"`
	// The output's name, as defined in the workflow
	Name  string        `json:"name"`
	Value *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A function call output from a Workflow execution.

func (*WorkflowOutputFunctionCall) String added in v0.2.1 

func (w *WorkflowOutputFunctionCall) String() string

func (*WorkflowOutputFunctionCall) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutputFunctionCall) UnmarshalJSON(data []byte) error

type WorkflowOutputImage added in v0.2.1 

type WorkflowOutputImage struct {
	Id string `json:"id"`
	// The output's name, as defined in the workflow
	Name  string       `json:"name"`
	Value *VellumImage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

An image output from a Workflow execution.

func (*WorkflowOutputImage) String added in v0.2.1 

func (w *WorkflowOutputImage) String() string

func (*WorkflowOutputImage) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutputImage) UnmarshalJSON(data []byte) error

type WorkflowOutputJson added in v0.2.1 

type WorkflowOutputJson struct {
	Id string `json:"id"`
	// The output's name, as defined in the workflow
	Name  string                 `json:"name"`
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A JSON output from a Workflow execution.

func (*WorkflowOutputJson) String added in v0.2.1 

func (w *WorkflowOutputJson) String() string

func (*WorkflowOutputJson) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutputJson) UnmarshalJSON(data []byte) error

type WorkflowOutputNumber added in v0.2.1 

type WorkflowOutputNumber struct {
	Id string `json:"id"`
	// The output's name, as defined in the workflow
	Name  string   `json:"name"`
	Value *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A number output from a Workflow execution.

func (*WorkflowOutputNumber) String added in v0.2.1 

func (w *WorkflowOutputNumber) String() string

func (*WorkflowOutputNumber) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutputNumber) UnmarshalJSON(data []byte) error

type WorkflowOutputSearchResults added in v0.2.1 

type WorkflowOutputSearchResults struct {
	Id string `json:"id"`
	// The output's name, as defined in the workflow
	Name  string          `json:"name"`
	Value []*SearchResult `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A search results output from a Workflow execution.

func (*WorkflowOutputSearchResults) String added in v0.2.1 

func (w *WorkflowOutputSearchResults) String() string

func (*WorkflowOutputSearchResults) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutputSearchResults) UnmarshalJSON(data []byte) error

type WorkflowOutputString added in v0.2.1 

type WorkflowOutputString struct {
	Id string `json:"id"`
	// The output's name, as defined in the workflow
	Name  string  `json:"name"`
	Value *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A string output from a Workflow execution.

func (*WorkflowOutputString) String added in v0.2.1 

func (w *WorkflowOutputString) String() string

func (*WorkflowOutputString) UnmarshalJSON added in v0.2.1 

func (w *WorkflowOutputString) UnmarshalJSON(data []byte) error

type WorkflowOutputVisitor added in v0.2.1 

type WorkflowOutputVisitor interface {
	VisitString(*WorkflowOutputString) error
	VisitNumber(*WorkflowOutputNumber) error
	VisitJson(*WorkflowOutputJson) error
	VisitChatHistory(*WorkflowOutputChatHistory) error
	VisitSearchResults(*WorkflowOutputSearchResults) error
	VisitArray(*WorkflowOutputArray) error
	VisitError(*WorkflowOutputError) error
	VisitFunctionCall(*WorkflowOutputFunctionCall) error
	VisitImage(*WorkflowOutputImage) error
}

type WorkflowRequestChatHistoryInputRequest 

type WorkflowRequestChatHistoryInputRequest struct {
	// The variable's name, as defined in the Workflow.
	Name  string                `json:"name"`
	Value []*ChatMessageRequest `json:"value,omitempty"`
	// contains filtered or unexported fields
}

The input for a chat history variable in a Workflow.

func (*WorkflowRequestChatHistoryInputRequest) String 

func (w *WorkflowRequestChatHistoryInputRequest) String() string

func (*WorkflowRequestChatHistoryInputRequest) UnmarshalJSON 

func (w *WorkflowRequestChatHistoryInputRequest) UnmarshalJSON(data []byte) error

type WorkflowRequestInputRequest 

type WorkflowRequestInputRequest struct {
	Type        string
	String      *WorkflowRequestStringInputRequest
	Json        *WorkflowRequestJsonInputRequest
	ChatHistory *WorkflowRequestChatHistoryInputRequest
	Number      *WorkflowRequestNumberInputRequest
}

func NewWorkflowRequestInputRequestFromChatHistory 

func NewWorkflowRequestInputRequestFromChatHistory(value *WorkflowRequestChatHistoryInputRequest) *WorkflowRequestInputRequest

func NewWorkflowRequestInputRequestFromJson 

func NewWorkflowRequestInputRequestFromJson(value *WorkflowRequestJsonInputRequest) *WorkflowRequestInputRequest

func NewWorkflowRequestInputRequestFromNumber 

func NewWorkflowRequestInputRequestFromNumber(value *WorkflowRequestNumberInputRequest) *WorkflowRequestInputRequest

func NewWorkflowRequestInputRequestFromString 

func NewWorkflowRequestInputRequestFromString(value *WorkflowRequestStringInputRequest) *WorkflowRequestInputRequest

func (*WorkflowRequestInputRequest) Accept 

func (w *WorkflowRequestInputRequest) Accept(visitor WorkflowRequestInputRequestVisitor) error

func (WorkflowRequestInputRequest) MarshalJSON 

func (w WorkflowRequestInputRequest) MarshalJSON() ([]byte, error)

func (*WorkflowRequestInputRequest) UnmarshalJSON 

func (w *WorkflowRequestInputRequest) UnmarshalJSON(data []byte) error

type WorkflowRequestInputRequestVisitor 

type WorkflowRequestInputRequestVisitor interface {
	VisitString(*WorkflowRequestStringInputRequest) error
	VisitJson(*WorkflowRequestJsonInputRequest) error
	VisitChatHistory(*WorkflowRequestChatHistoryInputRequest) error
	VisitNumber(*WorkflowRequestNumberInputRequest) error
}

type WorkflowRequestJsonInputRequest 

type WorkflowRequestJsonInputRequest struct {
	// The variable's name, as defined in the Workflow.
	Name  string                 `json:"name"`
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

The input for a JSON variable in a Workflow.

func (*WorkflowRequestJsonInputRequest) String 

func (w *WorkflowRequestJsonInputRequest) String() string

func (*WorkflowRequestJsonInputRequest) UnmarshalJSON 

func (w *WorkflowRequestJsonInputRequest) UnmarshalJSON(data []byte) error

type WorkflowRequestNumberInputRequest 

type WorkflowRequestNumberInputRequest struct {
	// The variable's name, as defined in the Workflow.
	Name  string  `json:"name"`
	Value float64 `json:"value"`
	// contains filtered or unexported fields
}

The input for a number variable in a Workflow.

func (*WorkflowRequestNumberInputRequest) String 

func (w *WorkflowRequestNumberInputRequest) String() string

func (*WorkflowRequestNumberInputRequest) UnmarshalJSON 

func (w *WorkflowRequestNumberInputRequest) UnmarshalJSON(data []byte) error

type WorkflowRequestStringInputRequest 

type WorkflowRequestStringInputRequest struct {
	// The variable's name, as defined in the Workflow.
	Name  string `json:"name"`
	Value string `json:"value"`
	// contains filtered or unexported fields
}

The input for a string variable in a Workflow.

func (*WorkflowRequestStringInputRequest) String 

func (w *WorkflowRequestStringInputRequest) String() string

func (*WorkflowRequestStringInputRequest) UnmarshalJSON 

func (w *WorkflowRequestStringInputRequest) UnmarshalJSON(data []byte) error

type WorkflowResultEvent 

type WorkflowResultEvent struct {
	Id      string                         `json:"id"`
	State   WorkflowNodeResultEventState   `json:"state,omitempty"`
	Ts      time.Time                      `json:"ts"`
	Output  *WorkflowResultEventOutputData `json:"output,omitempty"`
	Error   *WorkflowEventError            `json:"error,omitempty"`
	Outputs []*WorkflowOutput              `json:"outputs,omitempty"`
	Inputs  []*ExecutionVellumValue        `json:"inputs,omitempty"`
	// contains filtered or unexported fields
}

func (*WorkflowResultEvent) String 

func (w *WorkflowResultEvent) String() string

func (*WorkflowResultEvent) UnmarshalJSON 

func (w *WorkflowResultEvent) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputData 

type WorkflowResultEventOutputData struct {
	Type          string
	String        *WorkflowResultEventOutputDataString
	Number        *WorkflowResultEventOutputDataNumber
	Json          *WorkflowResultEventOutputDataJson
	ChatHistory   *WorkflowResultEventOutputDataChatHistory
	SearchResults *WorkflowResultEventOutputDataSearchResults
	Array         *WorkflowResultEventOutputDataArray
	FunctionCall  *WorkflowResultEventOutputDataFunctionCall
	Error         *WorkflowResultEventOutputDataError
}

func NewWorkflowResultEventOutputDataFromArray added in v0.3.9 

func NewWorkflowResultEventOutputDataFromArray(value *WorkflowResultEventOutputDataArray) *WorkflowResultEventOutputData

func NewWorkflowResultEventOutputDataFromChatHistory 

func NewWorkflowResultEventOutputDataFromChatHistory(value *WorkflowResultEventOutputDataChatHistory) *WorkflowResultEventOutputData

func NewWorkflowResultEventOutputDataFromError 

func NewWorkflowResultEventOutputDataFromError(value *WorkflowResultEventOutputDataError) *WorkflowResultEventOutputData

func NewWorkflowResultEventOutputDataFromFunctionCall added in v0.3.9 

func NewWorkflowResultEventOutputDataFromFunctionCall(value *WorkflowResultEventOutputDataFunctionCall) *WorkflowResultEventOutputData

func NewWorkflowResultEventOutputDataFromJson 

func NewWorkflowResultEventOutputDataFromJson(value *WorkflowResultEventOutputDataJson) *WorkflowResultEventOutputData

func NewWorkflowResultEventOutputDataFromNumber 

func NewWorkflowResultEventOutputDataFromNumber(value *WorkflowResultEventOutputDataNumber) *WorkflowResultEventOutputData

func NewWorkflowResultEventOutputDataFromSearchResults 

func NewWorkflowResultEventOutputDataFromSearchResults(value *WorkflowResultEventOutputDataSearchResults) *WorkflowResultEventOutputData

func NewWorkflowResultEventOutputDataFromString 

func NewWorkflowResultEventOutputDataFromString(value *WorkflowResultEventOutputDataString) *WorkflowResultEventOutputData

func (*WorkflowResultEventOutputData) Accept 

func (w *WorkflowResultEventOutputData) Accept(visitor WorkflowResultEventOutputDataVisitor) error

func (WorkflowResultEventOutputData) MarshalJSON 

func (w WorkflowResultEventOutputData) MarshalJSON() ([]byte, error)

func (*WorkflowResultEventOutputData) UnmarshalJSON 

func (w *WorkflowResultEventOutputData) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputDataArray added in v0.3.9 

type WorkflowResultEventOutputDataArray struct {
	Id     *string                      `json:"id,omitempty"`
	Name   string                       `json:"name"`
	State  WorkflowNodeResultEventState `json:"state,omitempty"`
	NodeId string                       `json:"node_id"`
	// The newly output string value. Only relevant for string outputs with a state of STREAMING.
	Delta *string                   `json:"delta,omitempty"`
	Value []*ArrayVariableValueItem `json:"value,omitempty"`
	// contains filtered or unexported fields
}

An Array output returned from a Workflow execution.

func (*WorkflowResultEventOutputDataArray) String added in v0.3.9 

func (w *WorkflowResultEventOutputDataArray) String() string

func (*WorkflowResultEventOutputDataArray) UnmarshalJSON added in v0.3.9 

func (w *WorkflowResultEventOutputDataArray) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputDataChatHistory 

type WorkflowResultEventOutputDataChatHistory struct {
	Id     *string                      `json:"id,omitempty"`
	Name   string                       `json:"name"`
	State  WorkflowNodeResultEventState `json:"state,omitempty"`
	NodeId string                       `json:"node_id"`
	// The newly output string value. Only relevant for string outputs with a state of STREAMING.
	Delta *string        `json:"delta,omitempty"`
	Value []*ChatMessage `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A Chat History output streamed from a Workflow execution.

func (*WorkflowResultEventOutputDataChatHistory) String 

func (w *WorkflowResultEventOutputDataChatHistory) String() string

func (*WorkflowResultEventOutputDataChatHistory) UnmarshalJSON 

func (w *WorkflowResultEventOutputDataChatHistory) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputDataError 

type WorkflowResultEventOutputDataError struct {
	Id     *string                      `json:"id,omitempty"`
	Name   string                       `json:"name"`
	State  WorkflowNodeResultEventState `json:"state,omitempty"`
	NodeId string                       `json:"node_id"`
	// The newly output string value. Only relevant for string outputs with a state of STREAMING.
	Delta *string      `json:"delta,omitempty"`
	Value *VellumError `json:"value,omitempty"`
	// contains filtered or unexported fields
}

An Error output streamed from a Workflow execution.

func (*WorkflowResultEventOutputDataError) String 

func (w *WorkflowResultEventOutputDataError) String() string

func (*WorkflowResultEventOutputDataError) UnmarshalJSON 

func (w *WorkflowResultEventOutputDataError) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputDataFunctionCall added in v0.3.9 

type WorkflowResultEventOutputDataFunctionCall struct {
	Id     *string                      `json:"id,omitempty"`
	Name   string                       `json:"name"`
	State  WorkflowNodeResultEventState `json:"state,omitempty"`
	NodeId string                       `json:"node_id"`
	// The newly output string value. Only relevant for string outputs with a state of STREAMING.
	Delta *string       `json:"delta,omitempty"`
	Value *FunctionCall `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A Function Call output returned from a Workflow execution.

func (*WorkflowResultEventOutputDataFunctionCall) String added in v0.3.9 

func (w *WorkflowResultEventOutputDataFunctionCall) String() string

func (*WorkflowResultEventOutputDataFunctionCall) UnmarshalJSON added in v0.3.9 

func (w *WorkflowResultEventOutputDataFunctionCall) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputDataJson 

type WorkflowResultEventOutputDataJson struct {
	Id     *string                      `json:"id,omitempty"`
	Name   string                       `json:"name"`
	State  WorkflowNodeResultEventState `json:"state,omitempty"`
	NodeId string                       `json:"node_id"`
	// The newly output string value. Only relevant for string outputs with a state of STREAMING.
	Delta *string                `json:"delta,omitempty"`
	Value map[string]interface{} `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A JSON output streamed from a Workflow execution.

func (*WorkflowResultEventOutputDataJson) String 

func (w *WorkflowResultEventOutputDataJson) String() string

func (*WorkflowResultEventOutputDataJson) UnmarshalJSON 

func (w *WorkflowResultEventOutputDataJson) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputDataNumber 

type WorkflowResultEventOutputDataNumber struct {
	Id     *string                      `json:"id,omitempty"`
	Name   string                       `json:"name"`
	State  WorkflowNodeResultEventState `json:"state,omitempty"`
	NodeId string                       `json:"node_id"`
	// The newly output string value. Only relevant for string outputs with a state of STREAMING.
	Delta *string  `json:"delta,omitempty"`
	Value *float64 `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A number output streamed from a Workflow execution.

func (*WorkflowResultEventOutputDataNumber) String 

func (w *WorkflowResultEventOutputDataNumber) String() string

func (*WorkflowResultEventOutputDataNumber) UnmarshalJSON 

func (w *WorkflowResultEventOutputDataNumber) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputDataSearchResults 

type WorkflowResultEventOutputDataSearchResults struct {
	Id     *string                      `json:"id,omitempty"`
	Name   string                       `json:"name"`
	State  WorkflowNodeResultEventState `json:"state,omitempty"`
	NodeId string                       `json:"node_id"`
	// The newly output string value. Only relevant for string outputs with a state of STREAMING.
	Delta *string         `json:"delta,omitempty"`
	Value []*SearchResult `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A Search Results output streamed from a Workflow execution.

func (*WorkflowResultEventOutputDataSearchResults) String 

func (w *WorkflowResultEventOutputDataSearchResults) String() string

func (*WorkflowResultEventOutputDataSearchResults) UnmarshalJSON 

func (w *WorkflowResultEventOutputDataSearchResults) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputDataString 

type WorkflowResultEventOutputDataString struct {
	Id     *string                      `json:"id,omitempty"`
	Name   string                       `json:"name"`
	State  WorkflowNodeResultEventState `json:"state,omitempty"`
	NodeId string                       `json:"node_id"`
	// The newly output string value, meant to be concatenated with all previous. Will be non-null for events of state STREAMING.
	Delta *string `json:"delta,omitempty"`
	// The entire string value. Will be non-null for events of state FULFILLED.
	Value *string `json:"value,omitempty"`
	// contains filtered or unexported fields
}

A string output streamed from a Workflow execution.

func (*WorkflowResultEventOutputDataString) String 

func (w *WorkflowResultEventOutputDataString) String() string

func (*WorkflowResultEventOutputDataString) UnmarshalJSON 

func (w *WorkflowResultEventOutputDataString) UnmarshalJSON(data []byte) error

type WorkflowResultEventOutputDataVisitor 

type WorkflowResultEventOutputDataVisitor interface {
	VisitString(*WorkflowResultEventOutputDataString) error
	VisitNumber(*WorkflowResultEventOutputDataNumber) error
	VisitJson(*WorkflowResultEventOutputDataJson) error
	VisitChatHistory(*WorkflowResultEventOutputDataChatHistory) error
	VisitSearchResults(*WorkflowResultEventOutputDataSearchResults) error
	VisitArray(*WorkflowResultEventOutputDataArray) error
	VisitFunctionCall(*WorkflowResultEventOutputDataFunctionCall) error
	VisitError(*WorkflowResultEventOutputDataError) error
}

type WorkflowStreamEvent 

type WorkflowStreamEvent struct {
	Type     string
	Workflow *WorkflowExecutionWorkflowResultEvent
	Node     *WorkflowExecutionNodeResultEvent
}

func NewWorkflowStreamEventFromNode 

func NewWorkflowStreamEventFromNode(value *WorkflowExecutionNodeResultEvent) *WorkflowStreamEvent

func NewWorkflowStreamEventFromWorkflow 

func NewWorkflowStreamEventFromWorkflow(value *WorkflowExecutionWorkflowResultEvent) *WorkflowStreamEvent

func (*WorkflowStreamEvent) Accept 

func (w *WorkflowStreamEvent) Accept(visitor WorkflowStreamEventVisitor) error

func (WorkflowStreamEvent) MarshalJSON 

func (w WorkflowStreamEvent) MarshalJSON() ([]byte, error)

func (*WorkflowStreamEvent) UnmarshalJSON 

func (w *WorkflowStreamEvent) UnmarshalJSON(data []byte) error

type WorkflowStreamEventVisitor 

type WorkflowStreamEventVisitor interface {
	VisitWorkflow(*WorkflowExecutionWorkflowResultEvent) error
	VisitNode(*WorkflowExecutionNodeResultEvent) error
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.