githubcomusesapientgosdk

package module
v0.2.0 Latest Latest
Warning

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

 Go to latest Published: May 15, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

README

Sapient Go API Library

Go Reference

The Sapient Go library provides convenient access to the Sapient REST API from applications written in Go.

It is generated with Stainless.

Installation

import (
	"github.com/usesapient/go-sdk" // imported as githubcomusesapientgosdk
)

Or to pin the version:

go get -u 'github.com/usesapient/go-sdk@v0.2.0'

Requirements

This library requires Go 1.22+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"fmt"

	"github.com/usesapient/go-sdk"
	"github.com/usesapient/go-sdk/option"
)

func main() {
	client := githubcomusesapientgosdk.NewClient(
		option.WithAPIKey("My API Key"), // defaults to os.LookupEnv("SAPIENT_API_KEY")
	)
	status, err := client.Status.Get(context.TODO())
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", status)
}
Request fields

The githubcomusesapientgosdk library uses the omitzero semantics from the Go 1.24+ encoding/json release for request fields.

Required primitive fields (int64, string, etc.) feature the tag `api:"required"`. These fields are always serialized, even their zero values.

Optional primitive types are wrapped in a param.Opt[T]. These fields can be set with the provided constructors, githubcomusesapientgosdk.String(string), githubcomusesapientgosdk.Int(int64), etc.

Any param.Opt[T], map, slice, struct or string enum uses the tag `json:"...,omitzero"`. Its zero value is considered omitted.

The param.IsOmitted(any) function can confirm the presence of any omitzero field.

p := githubcomusesapientgosdk.ExampleParams{
	ID:   "id_xxx",                               // required property
	Name: githubcomusesapientgosdk.String("..."), // optional property

	Point: githubcomusesapientgosdk.Point{
		X: 0,                               // required field will serialize as 0
		Y: githubcomusesapientgosdk.Int(1), // optional field will serialize as 1
		// ... omitted non-required fields will not be serialized
	},

	Origin: githubcomusesapientgosdk.Origin{}, // the zero value of [Origin] is considered omitted
}

To send null instead of a param.Opt[T], use param.Null[T](). To send null instead of a struct T, use param.NullStruct[T]().

p.Name = param.Null[string]()       // 'null' instead of string
p.Point = param.NullStruct[Point]() // 'null' instead of struct

param.IsNull(p.Name)  // true
param.IsNull(p.Point) // true

Request structs contain a .SetExtraFields(map[string]any) method which can send non-conforming fields in the request body. Extra fields overwrite any struct fields with a matching key. For security reasons, only use SetExtraFields with trusted data.

To send a custom value instead of a struct, use param.Override[T](value).

// In cases where the API specifies a given type,
// but you want to send something else, use [SetExtraFields]:
p.SetExtraFields(map[string]any{
	"x": 0.01, // send "x" as a float instead of int
})

// Send a number instead of an object
custom := param.Override[githubcomusesapientgosdk.FooParams](12)
Request unions

Unions are represented as a struct with fields prefixed by "Of" for each of its variants, only one field can be non-zero. The non-zero field will be serialized.

Sub-properties of the union can be accessed via methods on the union struct. These methods return a mutable pointer to the underlying data, if present.

// Only one field can be non-zero, use param.IsOmitted() to check if a field is set
type AnimalUnionParam struct {
	OfCat *Cat `json:",omitzero,inline`
	OfDog *Dog `json:",omitzero,inline`
}

animal := AnimalUnionParam{
	OfCat: &Cat{
		Name: "Whiskers",
		Owner: PersonParam{
			Address: AddressParam{Street: "3333 Coyote Hill Rd", Zip: 0},
		},
	},
}

// Mutating a field
if address := animal.GetOwner().GetAddress(); address != nil {
	address.ZipCode = 94304
}
Response objects

All fields in response structs are ordinary value types (not pointers or wrappers). Response structs also include a special JSON field containing metadata about each property.

type Animal struct {
	Name   string `json:"name,nullable"`
	Owners int    `json:"owners"`
	Age    int    `json:"age"`
	JSON   struct {
		Name        respjson.Field
		Owner       respjson.Field
		Age         respjson.Field
		ExtraFields map[string]respjson.Field
	} `json:"-"`
}

To handle optional data, use the .Valid() method on the JSON field. .Valid() returns true if a field is not null, not present, or couldn't be marshaled.

If .Valid() is false, the corresponding field will simply be its zero value.

raw := `{"owners": 1, "name": null}`

var res Animal
json.Unmarshal([]byte(raw), &res)

// Accessing regular fields

res.Owners // 1
res.Name   // ""
res.Age    // 0

// Optional field checks

res.JSON.Owners.Valid() // true
res.JSON.Name.Valid()   // false
res.JSON.Age.Valid()    // false

// Raw JSON values

res.JSON.Owners.Raw()                  // "1"
res.JSON.Name.Raw() == "null"          // true
res.JSON.Name.Raw() == respjson.Null   // true
res.JSON.Age.Raw() == ""               // true
res.JSON.Age.Raw() == respjson.Omitted // true

These .JSON structs also include an ExtraFields map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
Response Unions

In responses, unions are represented by a flattened struct containing all possible fields from each of the object variants. To convert it to a variant use the .AsFooVariant() method or the .AsAny() method if present.

If a response value union contains primitive values, primitive fields will be alongside the properties but prefixed with Of and feature the tag json:"...,inline".

type AnimalUnion struct {
	// From variants [Dog], [Cat]
	Owner Person `json:"owner"`
	// From variant [Dog]
	DogBreed string `json:"dog_breed"`
	// From variant [Cat]
	CatBreed string `json:"cat_breed"`
	// ...

	JSON struct {
		Owner respjson.Field
		// ...
	} `json:"-"`
}

// If animal variant
if animal.Owner.Address.ZipCode == "" {
	panic("missing zip code")
}

// Switch on the variant
switch variant := animal.AsAny().(type) {
case Dog:
case Cat:
default:
	panic("unexpected type")
}
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := githubcomusesapientgosdk.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Status.Get(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

The request option option.WithDebugLog(nil) may be helpful while debugging.

See the full list of request options.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

Errors

When the API returns a non-success status code, we return an error with type *githubcomusesapientgosdk.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Status.Get(context.TODO())
if err != nil {
	var apierr *githubcomusesapientgosdk.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/v1/status": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Status.Get(
	ctx,
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)
File uploads

Request parameters that correspond to file uploads in multipart requests are typed as io.Reader. The contents of the io.Reader will by default be sent as a multipart form part with the file name of "anonymous_file" and content-type of "application/octet-stream".

The file name and content-type can be customized by implementing Name() string or ContentType() string on the run-time type of io.Reader. Note that os.File implements Name() string, so a file returned by os.Open will be sent with the file name on disk.

We also provide a helper githubcomusesapientgosdk.File(reader io.Reader, filename string, contentType string) which can be used to wrap any io.Reader with the appropriate file name and content type.

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := githubcomusesapientgosdk.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Status.Get(context.TODO(), option.WithMaxRetries(5))
Accessing raw response data (e.g. response headers)

You can access the raw HTTP response data by using the option.WithResponseInto() request option. This is useful when you need to examine response headers, status codes, or other details.

// Create a variable to store the HTTP response
var response *http.Response
status, err := client.Status.Get(context.TODO(), option.WithResponseInto(&response))
if err != nil {
	// handle error
}
fmt.Printf("%+v\n", status)

fmt.Printf("Status Code: %d\n", response.StatusCode)
fmt.Printf("Headers: %+#v\n", response.Header)
Making custom/undocumented requests

This library is typed for convenient access to the documented API. If you need to access undocumented endpoints, params, or response properties, the library can still be used.

Undocumented endpoints

To make requests to undocumented endpoints, you can use client.Get, client.Post, and other HTTP verbs. RequestOptions on the client, such as retries, will be respected when making these requests.

var (
    // params can be an io.Reader, a []byte, an encoding/json serializable object,
    // or a "…Params" struct defined in this library.
    params map[string]any

    // result can be an []byte, *http.Response, a encoding/json deserializable object,
    // or a model defined in this library.
    result *http.Response
)
err := client.Post(context.Background(), "/unspecified", params, &result)
if err != nil {
    …
}
Undocumented request params

To make requests using undocumented parameters, you may use either the option.WithQuerySet() or the option.WithJSONSet() methods.

params := FooNewParams{
    ID:   "id_xxxx",
    Data: FooNewParamsData{
        FirstName: githubcomusesapientgosdk.String("John"),
    },
}
client.Foo.New(context.Background(), params, option.WithJSONSet("data.last_name", "Doe"))
Undocumented response properties

To access undocumented response properties, you may either access the raw JSON of the response as a string with result.JSON.RawJSON(), or get the raw JSON of a particular field on the result with result.JSON.Foo.Raw().

Any fields that are not present on the response struct will be saved and can be accessed by result.JSON.ExtraFields() which returns the extra fields as a map[string]Field.

Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := githubcomusesapientgosdk.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals.)
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Contributing

See the contributing documentation.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool 

func Bool(b bool) param.Opt[bool]

func BoolPtr 

func BoolPtr(v bool) *bool

func DefaultClientOptions 

func DefaultClientOptions() []option.RequestOption

DefaultClientOptions read from the environment (SAPIENT_API_KEY, SAPIENT_BASE_URL). This should be used to initialize new clients.

func File 

func File(rdr io.Reader, filename string, contentType string) file

func Float 

func Float(f float64) param.Opt[float64]

func FloatPtr 

func FloatPtr(v float64) *float64

func Int 

func Int(i int64) param.Opt[int64]

func IntPtr 

func IntPtr(v int64) *int64

func Opt 

func Opt[T comparable](v T) param.Opt[T]

func Ptr 

func Ptr[T any](v T) *T

func String 

func String(s string) param.Opt[string]

func StringPtr 

func StringPtr(v string) *string

func Time 

func Time(t time.Time) param.Opt[time.Time]

func TimePtr 

func TimePtr(v time.Time) *time.Time

Types

type APIPerformanceEvaluationConfigGetParams 

type APIPerformanceEvaluationConfigGetParams struct {
	InterfaceID param.Opt[string] `query:"interface_id,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (APIPerformanceEvaluationConfigGetParams) URLQuery 

func (r APIPerformanceEvaluationConfigGetParams) URLQuery() (v url.Values, err error)

URLQuery serializes APIPerformanceEvaluationConfigGetParams's query parameters as `url.Values`.

type APIPerformanceEvaluationConfigGetResponse 

type APIPerformanceEvaluationConfigGetResponse struct {
	OperationIDs []string `json:"operation_ids" api:"required"`
	APIBaseURL   string   `json:"api_base_url" api:"nullable"`
	EnvVarKeys   []string `json:"env_var_keys"`
	EvalTypes    []string `json:"eval_types"`
	Framework    string   `json:"framework" api:"nullable"`
	Platforms    []string `json:"platforms"`
	UseCaseIDs   []string `json:"use_case_ids"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		OperationIDs respjson.Field
		APIBaseURL   respjson.Field
		EnvVarKeys   respjson.Field
		EvalTypes    respjson.Field
		Framework    respjson.Field
		Platforms    respjson.Field
		UseCaseIDs   respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceEvaluationConfigGetResponse) RawJSON 

func (r APIPerformanceEvaluationConfigGetResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceEvaluationConfigGetResponse) UnmarshalJSON 

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

type APIPerformanceEvaluationConfigService 

type APIPerformanceEvaluationConfigService struct {
	Options []option.RequestOption
}

APIPerformanceEvaluationConfigService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAPIPerformanceEvaluationConfigService method instead.

func NewAPIPerformanceEvaluationConfigService 

func NewAPIPerformanceEvaluationConfigService(opts ...option.RequestOption) (r APIPerformanceEvaluationConfigService)

NewAPIPerformanceEvaluationConfigService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*APIPerformanceEvaluationConfigService) Get 

func (r *APIPerformanceEvaluationConfigService) Get(ctx context.Context, query APIPerformanceEvaluationConfigGetParams, opts ...option.RequestOption) (res *APIPerformanceEvaluationConfigGetResponse, err error)

Retrieve Evaluation Config

func (*APIPerformanceEvaluationConfigService) Update 

func (r *APIPerformanceEvaluationConfigService) Update(ctx context.Context, body APIPerformanceEvaluationConfigUpdateParams, opts ...option.RequestOption) (res *APIPerformanceEvaluationConfigUpdateResponse, err error)

Update Evaluation Config

type APIPerformanceEvaluationConfigUpdateParams 

type APIPerformanceEvaluationConfigUpdateParams struct {
	APIBaseURL   param.Opt[string] `json:"api_base_url,omitzero"`
	Framework    param.Opt[string] `json:"framework,omitzero"`
	InterfaceID  param.Opt[string] `json:"interface_id,omitzero"`
	EnvVars      map[string]string `json:"env_vars,omitzero"`
	EvalTypes    []string          `json:"eval_types,omitzero"`
	OperationIDs []string          `json:"operation_ids,omitzero"`
	Platforms    []string          `json:"platforms,omitzero"`
	UseCaseIDs   []string          `json:"use_case_ids,omitzero"`
	// contains filtered or unexported fields
}

func (APIPerformanceEvaluationConfigUpdateParams) MarshalJSON 

func (r APIPerformanceEvaluationConfigUpdateParams) MarshalJSON() (data []byte, err error)

func (*APIPerformanceEvaluationConfigUpdateParams) UnmarshalJSON 

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

type APIPerformanceEvaluationConfigUpdateResponse 

type APIPerformanceEvaluationConfigUpdateResponse struct {
	OperationIDs []string `json:"operation_ids" api:"required"`
	APIBaseURL   string   `json:"api_base_url" api:"nullable"`
	EnvVarKeys   []string `json:"env_var_keys"`
	EvalTypes    []string `json:"eval_types"`
	Framework    string   `json:"framework" api:"nullable"`
	Platforms    []string `json:"platforms"`
	UseCaseIDs   []string `json:"use_case_ids"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		OperationIDs respjson.Field
		APIBaseURL   respjson.Field
		EnvVarKeys   respjson.Field
		EvalTypes    respjson.Field
		Framework    respjson.Field
		Platforms    respjson.Field
		UseCaseIDs   respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceEvaluationConfigUpdateResponse) RawJSON 

func (r APIPerformanceEvaluationConfigUpdateResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceEvaluationConfigUpdateResponse) UnmarshalJSON 

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

type APIPerformanceInterfaceListResponse 

type APIPerformanceInterfaceListResponse struct {
	Interfaces []APIPerformanceInterfaceListResponseInterface `json:"interfaces" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Interfaces  respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceInterfaceListResponse) RawJSON 

func (r APIPerformanceInterfaceListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceInterfaceListResponse) UnmarshalJSON 

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

type APIPerformanceInterfaceListResponseInterface 

type APIPerformanceInterfaceListResponseInterface struct {
	ID             string `json:"id" api:"required"`
	Label          string `json:"label" api:"required"`
	Type           string `json:"type" api:"required"`
	CreatedAt      string `json:"created_at" api:"nullable"`
	OperationCount int64  `json:"operation_count"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		Label          respjson.Field
		Type           respjson.Field
		CreatedAt      respjson.Field
		OperationCount respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceInterfaceListResponseInterface) RawJSON 

func (r APIPerformanceInterfaceListResponseInterface) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceInterfaceListResponseInterface) UnmarshalJSON 

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

type APIPerformanceInterfaceService 

type APIPerformanceInterfaceService struct {
	Options []option.RequestOption
}

APIPerformanceInterfaceService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAPIPerformanceInterfaceService method instead.

func NewAPIPerformanceInterfaceService 

func NewAPIPerformanceInterfaceService(opts ...option.RequestOption) (r APIPerformanceInterfaceService)

NewAPIPerformanceInterfaceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*APIPerformanceInterfaceService) List 

func (r *APIPerformanceInterfaceService) List(ctx context.Context, opts ...option.RequestOption) (res *APIPerformanceInterfaceListResponse, err error)

List Interfaces

type APIPerformanceOperationDeleteResponse 

type APIPerformanceOperationDeleteResponse struct {
	Ok bool `json:"ok" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Ok          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationDeleteResponse) RawJSON added in v0.2.0 

func (r APIPerformanceOperationDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationDeleteResponse) UnmarshalJSON added in v0.2.0 

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

type APIPerformanceOperationGetResponse 

type APIPerformanceOperationGetResponse struct {
	ID                 string                                     `json:"id" api:"required"`
	Method             string                                     `json:"method" api:"required"`
	Path               string                                     `json:"path" api:"required"`
	Category           APIPerformanceOperationGetResponseCategory `json:"category" api:"nullable"`
	CreatedAt          string                                     `json:"created_at" api:"nullable"`
	Description        string                                     `json:"description" api:"nullable"`
	InterfaceID        string                                     `json:"interface_id" api:"nullable"`
	OpenAPIOperationID string                                     `json:"openapi_operation_id" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                 respjson.Field
		Method             respjson.Field
		Path               respjson.Field
		Category           respjson.Field
		CreatedAt          respjson.Field
		Description        respjson.Field
		InterfaceID        respjson.Field
		OpenAPIOperationID respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationGetResponse) RawJSON 

func (r APIPerformanceOperationGetResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationGetResponse) UnmarshalJSON 

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

type APIPerformanceOperationGetResponseCategory 

type APIPerformanceOperationGetResponseCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationGetResponseCategory) RawJSON 

func (r APIPerformanceOperationGetResponseCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationGetResponseCategory) UnmarshalJSON 

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

type APIPerformanceOperationListParams 

type APIPerformanceOperationListParams struct {
	CategoryID  param.Opt[string] `query:"category_id,omitzero" json:"-"`
	InterfaceID param.Opt[string] `query:"interface_id,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (APIPerformanceOperationListParams) URLQuery 

func (r APIPerformanceOperationListParams) URLQuery() (v url.Values, err error)

URLQuery serializes APIPerformanceOperationListParams's query parameters as `url.Values`.

type APIPerformanceOperationListResponse 

type APIPerformanceOperationListResponse struct {
	ID                 string                                      `json:"id" api:"required"`
	Method             string                                      `json:"method" api:"required"`
	Path               string                                      `json:"path" api:"required"`
	Category           APIPerformanceOperationListResponseCategory `json:"category" api:"nullable"`
	CreatedAt          string                                      `json:"created_at" api:"nullable"`
	Description        string                                      `json:"description" api:"nullable"`
	InterfaceID        string                                      `json:"interface_id" api:"nullable"`
	OpenAPIOperationID string                                      `json:"openapi_operation_id" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                 respjson.Field
		Method             respjson.Field
		Path               respjson.Field
		Category           respjson.Field
		CreatedAt          respjson.Field
		Description        respjson.Field
		InterfaceID        respjson.Field
		OpenAPIOperationID respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationListResponse) RawJSON 

func (r APIPerformanceOperationListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationListResponse) UnmarshalJSON 

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

type APIPerformanceOperationListResponseCategory 

type APIPerformanceOperationListResponseCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationListResponseCategory) RawJSON 

func (r APIPerformanceOperationListResponseCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationListResponseCategory) UnmarshalJSON 

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

type APIPerformanceOperationNewParams 

type APIPerformanceOperationNewParams struct {
	Method             string            `json:"method" api:"required"`
	Path               string            `json:"path" api:"required"`
	CategoryName       param.Opt[string] `json:"category_name,omitzero"`
	CategorySlug       param.Opt[string] `json:"category_slug,omitzero"`
	Description        param.Opt[string] `json:"description,omitzero"`
	InterfaceID        param.Opt[string] `json:"interface_id,omitzero"`
	OpenAPIOperationID param.Opt[string] `json:"openapi_operation_id,omitzero"`
	// contains filtered or unexported fields
}

func (APIPerformanceOperationNewParams) MarshalJSON 

func (r APIPerformanceOperationNewParams) MarshalJSON() (data []byte, err error)

func (*APIPerformanceOperationNewParams) UnmarshalJSON 

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

type APIPerformanceOperationNewResponse 

type APIPerformanceOperationNewResponse struct {
	ID                 string                                     `json:"id" api:"required"`
	Method             string                                     `json:"method" api:"required"`
	Path               string                                     `json:"path" api:"required"`
	Category           APIPerformanceOperationNewResponseCategory `json:"category" api:"nullable"`
	CreatedAt          string                                     `json:"created_at" api:"nullable"`
	Description        string                                     `json:"description" api:"nullable"`
	InterfaceID        string                                     `json:"interface_id" api:"nullable"`
	OpenAPIOperationID string                                     `json:"openapi_operation_id" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                 respjson.Field
		Method             respjson.Field
		Path               respjson.Field
		Category           respjson.Field
		CreatedAt          respjson.Field
		Description        respjson.Field
		InterfaceID        respjson.Field
		OpenAPIOperationID respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationNewResponse) RawJSON 

func (r APIPerformanceOperationNewResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationNewResponse) UnmarshalJSON 

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

type APIPerformanceOperationNewResponseCategory 

type APIPerformanceOperationNewResponseCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationNewResponseCategory) RawJSON 

func (r APIPerformanceOperationNewResponseCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationNewResponseCategory) UnmarshalJSON 

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

type APIPerformanceOperationPromptListResponse 

type APIPerformanceOperationPromptListResponse struct {
	ID               string           `json:"id" api:"required"`
	EvalType         string           `json:"eval_type" api:"required"`
	OperationID      string           `json:"operation_id" api:"required"`
	Prompt           string           `json:"prompt" api:"required"`
	CreatedAt        string           `json:"created_at" api:"nullable"`
	Enabled          bool             `json:"enabled"`
	ExpectedBehavior string           `json:"expected_behavior" api:"nullable"`
	Graders          []map[string]any `json:"graders"`
	ReferenceAnswer  string           `json:"reference_answer" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		EvalType         respjson.Field
		OperationID      respjson.Field
		Prompt           respjson.Field
		CreatedAt        respjson.Field
		Enabled          respjson.Field
		ExpectedBehavior respjson.Field
		Graders          respjson.Field
		ReferenceAnswer  respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationPromptListResponse) RawJSON 

func (r APIPerformanceOperationPromptListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationPromptListResponse) UnmarshalJSON 

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

type APIPerformanceOperationPromptNewParams 

type APIPerformanceOperationPromptNewParams struct {
	Prompt           string            `json:"prompt" api:"required"`
	ExpectedBehavior param.Opt[string] `json:"expected_behavior,omitzero"`
	ReferenceAnswer  param.Opt[string] `json:"reference_answer,omitzero"`
	EvalType         param.Opt[string] `json:"eval_type,omitzero"`
	Graders          []map[string]any  `json:"graders,omitzero"`
	// contains filtered or unexported fields
}

func (APIPerformanceOperationPromptNewParams) MarshalJSON 

func (r APIPerformanceOperationPromptNewParams) MarshalJSON() (data []byte, err error)

func (*APIPerformanceOperationPromptNewParams) UnmarshalJSON 

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

type APIPerformanceOperationPromptNewResponse 

type APIPerformanceOperationPromptNewResponse struct {
	ID               string           `json:"id" api:"required"`
	EvalType         string           `json:"eval_type" api:"required"`
	OperationID      string           `json:"operation_id" api:"required"`
	Prompt           string           `json:"prompt" api:"required"`
	CreatedAt        string           `json:"created_at" api:"nullable"`
	Enabled          bool             `json:"enabled"`
	ExpectedBehavior string           `json:"expected_behavior" api:"nullable"`
	Graders          []map[string]any `json:"graders"`
	ReferenceAnswer  string           `json:"reference_answer" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		EvalType         respjson.Field
		OperationID      respjson.Field
		Prompt           respjson.Field
		CreatedAt        respjson.Field
		Enabled          respjson.Field
		ExpectedBehavior respjson.Field
		Graders          respjson.Field
		ReferenceAnswer  respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationPromptNewResponse) RawJSON 

func (r APIPerformanceOperationPromptNewResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationPromptNewResponse) UnmarshalJSON 

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

type APIPerformanceOperationPromptService 

type APIPerformanceOperationPromptService struct {
	Options []option.RequestOption
}

APIPerformanceOperationPromptService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAPIPerformanceOperationPromptService method instead.

func NewAPIPerformanceOperationPromptService 

func NewAPIPerformanceOperationPromptService(opts ...option.RequestOption) (r APIPerformanceOperationPromptService)

NewAPIPerformanceOperationPromptService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*APIPerformanceOperationPromptService) List 

func (r *APIPerformanceOperationPromptService) List(ctx context.Context, operationID string, opts ...option.RequestOption) (res *[]APIPerformanceOperationPromptListResponse, err error)

List Operation Prompts

func (*APIPerformanceOperationPromptService) New 

func (r *APIPerformanceOperationPromptService) New(ctx context.Context, operationID string, body APIPerformanceOperationPromptNewParams, opts ...option.RequestOption) (res *APIPerformanceOperationPromptNewResponse, err error)

Create Operation Prompt

type APIPerformanceOperationService 

type APIPerformanceOperationService struct {
	Options []option.RequestOption
}

APIPerformanceOperationService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAPIPerformanceOperationService method instead.

func NewAPIPerformanceOperationService 

func NewAPIPerformanceOperationService(opts ...option.RequestOption) (r APIPerformanceOperationService)

NewAPIPerformanceOperationService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*APIPerformanceOperationService) Delete 

func (r *APIPerformanceOperationService) Delete(ctx context.Context, operationID string, opts ...option.RequestOption) (res *APIPerformanceOperationDeleteResponse, err error)

Delete Operation

func (*APIPerformanceOperationService) Get 

func (r *APIPerformanceOperationService) Get(ctx context.Context, operationID string, opts ...option.RequestOption) (res *APIPerformanceOperationGetResponse, err error)

Retrieve Operation

func (*APIPerformanceOperationService) List 

func (r *APIPerformanceOperationService) List(ctx context.Context, query APIPerformanceOperationListParams, opts ...option.RequestOption) (res *[]APIPerformanceOperationListResponse, err error)

List Operations

func (*APIPerformanceOperationService) New 

func (r *APIPerformanceOperationService) New(ctx context.Context, body APIPerformanceOperationNewParams, opts ...option.RequestOption) (res *APIPerformanceOperationNewResponse, err error)

Create Operation

func (*APIPerformanceOperationService) Update 

func (r *APIPerformanceOperationService) Update(ctx context.Context, operationID string, body APIPerformanceOperationUpdateParams, opts ...option.RequestOption) (res *APIPerformanceOperationUpdateResponse, err error)

Update Operation

type APIPerformanceOperationUpdateParams 

type APIPerformanceOperationUpdateParams struct {
	CategoryName       param.Opt[string] `json:"category_name,omitzero"`
	CategorySlug       param.Opt[string] `json:"category_slug,omitzero"`
	Description        param.Opt[string] `json:"description,omitzero"`
	InterfaceID        param.Opt[string] `json:"interface_id,omitzero"`
	Method             param.Opt[string] `json:"method,omitzero"`
	OpenAPIOperationID param.Opt[string] `json:"openapi_operation_id,omitzero"`
	Path               param.Opt[string] `json:"path,omitzero"`
	// contains filtered or unexported fields
}

func (APIPerformanceOperationUpdateParams) MarshalJSON 

func (r APIPerformanceOperationUpdateParams) MarshalJSON() (data []byte, err error)

func (*APIPerformanceOperationUpdateParams) UnmarshalJSON 

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

type APIPerformanceOperationUpdateResponse 

type APIPerformanceOperationUpdateResponse struct {
	ID                 string                                        `json:"id" api:"required"`
	Method             string                                        `json:"method" api:"required"`
	Path               string                                        `json:"path" api:"required"`
	Category           APIPerformanceOperationUpdateResponseCategory `json:"category" api:"nullable"`
	CreatedAt          string                                        `json:"created_at" api:"nullable"`
	Description        string                                        `json:"description" api:"nullable"`
	InterfaceID        string                                        `json:"interface_id" api:"nullable"`
	OpenAPIOperationID string                                        `json:"openapi_operation_id" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                 respjson.Field
		Method             respjson.Field
		Path               respjson.Field
		Category           respjson.Field
		CreatedAt          respjson.Field
		Description        respjson.Field
		InterfaceID        respjson.Field
		OpenAPIOperationID respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationUpdateResponse) RawJSON 

func (r APIPerformanceOperationUpdateResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationUpdateResponse) UnmarshalJSON 

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

type APIPerformanceOperationUpdateResponseCategory 

type APIPerformanceOperationUpdateResponseCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceOperationUpdateResponseCategory) RawJSON 

func (r APIPerformanceOperationUpdateResponseCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceOperationUpdateResponseCategory) UnmarshalJSON 

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

type APIPerformancePlatformEstimateCostResponse 

type APIPerformancePlatformEstimateCostResponse struct {
	Estimates    map[string]APIPerformancePlatformEstimateCostResponseEstimate `json:"estimates" api:"required"`
	TotalCredits int64                                                         `json:"total_credits" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Estimates    respjson.Field
		TotalCredits respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformancePlatformEstimateCostResponse) RawJSON 

func (r APIPerformancePlatformEstimateCostResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformancePlatformEstimateCostResponse) UnmarshalJSON 

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

type APIPerformancePlatformEstimateCostResponseEstimate added in v0.2.0 

type APIPerformancePlatformEstimateCostResponseEstimate struct {
	CreditsPerEval int64 `json:"credits_per_eval" api:"required"`
	EvalCount      int64 `json:"eval_count" api:"required"`
	TotalCredits   int64 `json:"total_credits" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		CreditsPerEval respjson.Field
		EvalCount      respjson.Field
		TotalCredits   respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformancePlatformEstimateCostResponseEstimate) RawJSON added in v0.2.0 

func (r APIPerformancePlatformEstimateCostResponseEstimate) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformancePlatformEstimateCostResponseEstimate) UnmarshalJSON added in v0.2.0 

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

type APIPerformancePlatformListResponse 

type APIPerformancePlatformListResponse struct {
	AgentPlatforms []APIPerformancePlatformListResponseAgentPlatform `json:"agent_platforms" api:"required"`
	TextPlatforms  []APIPerformancePlatformListResponseTextPlatform  `json:"text_platforms" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		AgentPlatforms respjson.Field
		TextPlatforms  respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformancePlatformListResponse) RawJSON 

func (r APIPerformancePlatformListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformancePlatformListResponse) UnmarshalJSON 

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

type APIPerformancePlatformListResponseAgentPlatform 

type APIPerformancePlatformListResponseAgentPlatform struct {
	ID             string `json:"id" api:"required"`
	CreditsPerEval int64  `json:"credits_per_eval" api:"required"`
	Label          string `json:"label" api:"required"`
	Provider       string `json:"provider" api:"required"`
	Type           string `json:"type" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		CreditsPerEval respjson.Field
		Label          respjson.Field
		Provider       respjson.Field
		Type           respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformancePlatformListResponseAgentPlatform) RawJSON 

func (r APIPerformancePlatformListResponseAgentPlatform) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformancePlatformListResponseAgentPlatform) UnmarshalJSON 

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

type APIPerformancePlatformListResponseTextPlatform 

type APIPerformancePlatformListResponseTextPlatform struct {
	ID             string `json:"id" api:"required"`
	CreditsPerEval int64  `json:"credits_per_eval" api:"required"`
	Label          string `json:"label" api:"required"`
	Provider       string `json:"provider" api:"required"`
	Type           string `json:"type" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID             respjson.Field
		CreditsPerEval respjson.Field
		Label          respjson.Field
		Provider       respjson.Field
		Type           respjson.Field
		ExtraFields    map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformancePlatformListResponseTextPlatform) RawJSON 

func (r APIPerformancePlatformListResponseTextPlatform) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformancePlatformListResponseTextPlatform) UnmarshalJSON 

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

type APIPerformancePlatformService 

type APIPerformancePlatformService struct {
	Options []option.RequestOption
}

APIPerformancePlatformService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAPIPerformancePlatformService method instead.

func NewAPIPerformancePlatformService 

func NewAPIPerformancePlatformService(opts ...option.RequestOption) (r APIPerformancePlatformService)

NewAPIPerformancePlatformService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*APIPerformancePlatformService) EstimateCost 

func (r *APIPerformancePlatformService) EstimateCost(ctx context.Context, opts ...option.RequestOption) (res *APIPerformancePlatformEstimateCostResponse, err error)

Estimate Platform Cost

func (*APIPerformancePlatformService) List 

func (r *APIPerformancePlatformService) List(ctx context.Context, opts ...option.RequestOption) (res *APIPerformancePlatformListResponse, err error)

List Platforms

type APIPerformancePromptDeleteResponse 

type APIPerformancePromptDeleteResponse struct {
	Ok bool `json:"ok" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Ok          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformancePromptDeleteResponse) RawJSON added in v0.2.0 

func (r APIPerformancePromptDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformancePromptDeleteResponse) UnmarshalJSON added in v0.2.0 

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

type APIPerformancePromptGetResponse 

type APIPerformancePromptGetResponse struct {
	ID               string           `json:"id" api:"required"`
	EvalType         string           `json:"eval_type" api:"required"`
	OperationID      string           `json:"operation_id" api:"required"`
	Prompt           string           `json:"prompt" api:"required"`
	CreatedAt        string           `json:"created_at" api:"nullable"`
	Enabled          bool             `json:"enabled"`
	ExpectedBehavior string           `json:"expected_behavior" api:"nullable"`
	Graders          []map[string]any `json:"graders"`
	ReferenceAnswer  string           `json:"reference_answer" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		EvalType         respjson.Field
		OperationID      respjson.Field
		Prompt           respjson.Field
		CreatedAt        respjson.Field
		Enabled          respjson.Field
		ExpectedBehavior respjson.Field
		Graders          respjson.Field
		ReferenceAnswer  respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformancePromptGetResponse) RawJSON 

func (r APIPerformancePromptGetResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformancePromptGetResponse) UnmarshalJSON 

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

type APIPerformancePromptService 

type APIPerformancePromptService struct {
	Options []option.RequestOption
}

APIPerformancePromptService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAPIPerformancePromptService method instead.

func NewAPIPerformancePromptService 

func NewAPIPerformancePromptService(opts ...option.RequestOption) (r APIPerformancePromptService)

NewAPIPerformancePromptService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*APIPerformancePromptService) Delete 

func (r *APIPerformancePromptService) Delete(ctx context.Context, promptID string, opts ...option.RequestOption) (res *APIPerformancePromptDeleteResponse, err error)

Delete Operation Prompt

func (*APIPerformancePromptService) Get 

func (r *APIPerformancePromptService) Get(ctx context.Context, promptID string, opts ...option.RequestOption) (res *APIPerformancePromptGetResponse, err error)

Retrieve Operation Prompt

func (*APIPerformancePromptService) Update 

func (r *APIPerformancePromptService) Update(ctx context.Context, promptID string, body APIPerformancePromptUpdateParams, opts ...option.RequestOption) (res *APIPerformancePromptUpdateResponse, err error)

Update Operation Prompt

type APIPerformancePromptUpdateParams 

type APIPerformancePromptUpdateParams struct {
	Enabled          param.Opt[bool]   `json:"enabled,omitzero"`
	ExpectedBehavior param.Opt[string] `json:"expected_behavior,omitzero"`
	Prompt           param.Opt[string] `json:"prompt,omitzero"`
	ReferenceAnswer  param.Opt[string] `json:"reference_answer,omitzero"`
	Graders          []map[string]any  `json:"graders,omitzero"`
	// contains filtered or unexported fields
}

func (APIPerformancePromptUpdateParams) MarshalJSON 

func (r APIPerformancePromptUpdateParams) MarshalJSON() (data []byte, err error)

func (*APIPerformancePromptUpdateParams) UnmarshalJSON 

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

type APIPerformancePromptUpdateResponse 

type APIPerformancePromptUpdateResponse struct {
	ID               string           `json:"id" api:"required"`
	EvalType         string           `json:"eval_type" api:"required"`
	OperationID      string           `json:"operation_id" api:"required"`
	Prompt           string           `json:"prompt" api:"required"`
	CreatedAt        string           `json:"created_at" api:"nullable"`
	Enabled          bool             `json:"enabled"`
	ExpectedBehavior string           `json:"expected_behavior" api:"nullable"`
	Graders          []map[string]any `json:"graders"`
	ReferenceAnswer  string           `json:"reference_answer" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		EvalType         respjson.Field
		OperationID      respjson.Field
		Prompt           respjson.Field
		CreatedAt        respjson.Field
		Enabled          respjson.Field
		ExpectedBehavior respjson.Field
		Graders          respjson.Field
		ReferenceAnswer  respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformancePromptUpdateResponse) RawJSON 

func (r APIPerformancePromptUpdateResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformancePromptUpdateResponse) UnmarshalJSON 

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

type APIPerformanceRunGetResponse 

type APIPerformanceRunGetResponse struct {
	Data      APIPerformanceRunGetResponseData      `json:"data" api:"required"`
	Operation APIPerformanceRunGetResponseOperation `json:"operation" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Operation   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceRunGetResponse) RawJSON 

func (r APIPerformanceRunGetResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceRunGetResponse) UnmarshalJSON 

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

type APIPerformanceRunGetResponseData 

type APIPerformanceRunGetResponseData struct {
	ID                string           `json:"id" api:"required"`
	APICallLog        map[string]any   `json:"api_call_log" api:"nullable"`
	ConversationTurns []map[string]any `json:"conversation_turns" api:"nullable"`
	CreatedAt         string           `json:"created_at" api:"nullable"`
	ErrorMessage      string           `json:"error_message" api:"nullable"`
	EvalID            string           `json:"eval_id" api:"nullable"`
	EvalType          string           `json:"eval_type" api:"nullable"`
	ExecutionStderr   string           `json:"execution_stderr" api:"nullable"`
	ExecutionStdout   string           `json:"execution_stdout" api:"nullable"`
	ExitCode          int64            `json:"exit_code" api:"nullable"`
	ExpectedBehavior  string           `json:"expected_behavior" api:"nullable"`
	FailureReasons    []string         `json:"failure_reasons" api:"nullable"`
	GeneratedFiles    map[string]any   `json:"generated_files" api:"nullable"`
	GraderResults     map[string]any   `json:"grader_results" api:"nullable"`
	Graders           []map[string]any `json:"graders"`
	LatencyMs         int64            `json:"latency_ms" api:"nullable"`
	Model             string           `json:"model" api:"nullable"`
	ModelType         string           `json:"model_type" api:"nullable"`
	Passed            bool             `json:"passed" api:"nullable"`
	Platform          string           `json:"platform" api:"nullable"`
	Prompt            string           `json:"prompt" api:"nullable"`
	RawResponse       string           `json:"raw_response" api:"nullable"`
	ReferenceAnswer   string           `json:"reference_answer" api:"nullable"`
	RunDate           string           `json:"run_date" api:"nullable"`
	Score             float64          `json:"score" api:"nullable"`
	TokensUsed        int64            `json:"tokens_used" api:"nullable"`
	ToolCalls         []map[string]any `json:"tool_calls" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                respjson.Field
		APICallLog        respjson.Field
		ConversationTurns respjson.Field
		CreatedAt         respjson.Field
		ErrorMessage      respjson.Field
		EvalID            respjson.Field
		EvalType          respjson.Field
		ExecutionStderr   respjson.Field
		ExecutionStdout   respjson.Field
		ExitCode          respjson.Field
		ExpectedBehavior  respjson.Field
		FailureReasons    respjson.Field
		GeneratedFiles    respjson.Field
		GraderResults     respjson.Field
		Graders           respjson.Field
		LatencyMs         respjson.Field
		Model             respjson.Field
		ModelType         respjson.Field
		Passed            respjson.Field
		Platform          respjson.Field
		Prompt            respjson.Field
		RawResponse       respjson.Field
		ReferenceAnswer   respjson.Field
		RunDate           respjson.Field
		Score             respjson.Field
		TokensUsed        respjson.Field
		ToolCalls         respjson.Field
		ExtraFields       map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceRunGetResponseData) RawJSON 

func (r APIPerformanceRunGetResponseData) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceRunGetResponseData) UnmarshalJSON 

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

type APIPerformanceRunGetResponseOperation 

type APIPerformanceRunGetResponseOperation struct {
	ID                 string                                        `json:"id" api:"required"`
	Method             string                                        `json:"method" api:"required"`
	Path               string                                        `json:"path" api:"required"`
	Category           APIPerformanceRunGetResponseOperationCategory `json:"category" api:"nullable"`
	CreatedAt          string                                        `json:"created_at" api:"nullable"`
	Description        string                                        `json:"description" api:"nullable"`
	InterfaceID        string                                        `json:"interface_id" api:"nullable"`
	OpenAPIOperationID string                                        `json:"openapi_operation_id" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                 respjson.Field
		Method             respjson.Field
		Path               respjson.Field
		Category           respjson.Field
		CreatedAt          respjson.Field
		Description        respjson.Field
		InterfaceID        respjson.Field
		OpenAPIOperationID respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceRunGetResponseOperation) RawJSON 

func (r APIPerformanceRunGetResponseOperation) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceRunGetResponseOperation) UnmarshalJSON 

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

type APIPerformanceRunGetResponseOperationCategory 

type APIPerformanceRunGetResponseOperationCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceRunGetResponseOperationCategory) RawJSON 

func (r APIPerformanceRunGetResponseOperationCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceRunGetResponseOperationCategory) UnmarshalJSON 

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

type APIPerformanceRunListParams 

type APIPerformanceRunListParams struct {
	OperationID string           `query:"operation_id" api:"required" json:"-"`
	Limit       param.Opt[int64] `query:"limit,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (APIPerformanceRunListParams) URLQuery 

func (r APIPerformanceRunListParams) URLQuery() (v url.Values, err error)

URLQuery serializes APIPerformanceRunListParams's query parameters as `url.Values`.

type APIPerformanceRunListResponse 

type APIPerformanceRunListResponse struct {
	Data      []APIPerformanceRunListResponseData    `json:"data" api:"required"`
	Meta      APIPerformanceRunListResponseMeta      `json:"meta" api:"required"`
	Operation APIPerformanceRunListResponseOperation `json:"operation" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Data        respjson.Field
		Meta        respjson.Field
		Operation   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceRunListResponse) RawJSON 

func (r APIPerformanceRunListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceRunListResponse) UnmarshalJSON 

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

type APIPerformanceRunListResponseData 

type APIPerformanceRunListResponseData struct {
	ID               string           `json:"id" api:"required"`
	CreatedAt        string           `json:"created_at" api:"nullable"`
	ErrorMessage     string           `json:"error_message" api:"nullable"`
	EvalID           string           `json:"eval_id" api:"nullable"`
	EvalType         string           `json:"eval_type" api:"nullable"`
	ExpectedBehavior string           `json:"expected_behavior" api:"nullable"`
	FailureReasons   []string         `json:"failure_reasons" api:"nullable"`
	Graders          []map[string]any `json:"graders"`
	LatencyMs        int64            `json:"latency_ms" api:"nullable"`
	Model            string           `json:"model" api:"nullable"`
	ModelType        string           `json:"model_type" api:"nullable"`
	Passed           bool             `json:"passed" api:"nullable"`
	Platform         string           `json:"platform" api:"nullable"`
	Prompt           string           `json:"prompt" api:"nullable"`
	ReferenceAnswer  string           `json:"reference_answer" api:"nullable"`
	RunDate          string           `json:"run_date" api:"nullable"`
	Score            float64          `json:"score" api:"nullable"`
	TokensUsed       int64            `json:"tokens_used" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		CreatedAt        respjson.Field
		ErrorMessage     respjson.Field
		EvalID           respjson.Field
		EvalType         respjson.Field
		ExpectedBehavior respjson.Field
		FailureReasons   respjson.Field
		Graders          respjson.Field
		LatencyMs        respjson.Field
		Model            respjson.Field
		ModelType        respjson.Field
		Passed           respjson.Field
		Platform         respjson.Field
		Prompt           respjson.Field
		ReferenceAnswer  respjson.Field
		RunDate          respjson.Field
		Score            respjson.Field
		TokensUsed       respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceRunListResponseData) RawJSON 

func (r APIPerformanceRunListResponseData) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceRunListResponseData) UnmarshalJSON 

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

type APIPerformanceRunListResponseMeta 

type APIPerformanceRunListResponseMeta struct {
	Count int64 `json:"count" api:"required"`
	Limit int64 `json:"limit" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Count       respjson.Field
		Limit       respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceRunListResponseMeta) RawJSON 

func (r APIPerformanceRunListResponseMeta) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceRunListResponseMeta) UnmarshalJSON 

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

type APIPerformanceRunListResponseOperation 

type APIPerformanceRunListResponseOperation struct {
	ID                 string                                         `json:"id" api:"required"`
	Method             string                                         `json:"method" api:"required"`
	Path               string                                         `json:"path" api:"required"`
	Category           APIPerformanceRunListResponseOperationCategory `json:"category" api:"nullable"`
	CreatedAt          string                                         `json:"created_at" api:"nullable"`
	Description        string                                         `json:"description" api:"nullable"`
	InterfaceID        string                                         `json:"interface_id" api:"nullable"`
	OpenAPIOperationID string                                         `json:"openapi_operation_id" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID                 respjson.Field
		Method             respjson.Field
		Path               respjson.Field
		Category           respjson.Field
		CreatedAt          respjson.Field
		Description        respjson.Field
		InterfaceID        respjson.Field
		OpenAPIOperationID respjson.Field
		ExtraFields        map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceRunListResponseOperation) RawJSON 

func (r APIPerformanceRunListResponseOperation) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceRunListResponseOperation) UnmarshalJSON 

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

type APIPerformanceRunListResponseOperationCategory 

type APIPerformanceRunListResponseOperationCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceRunListResponseOperationCategory) RawJSON 

func (r APIPerformanceRunListResponseOperationCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceRunListResponseOperationCategory) UnmarshalJSON 

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

type APIPerformanceRunService 

type APIPerformanceRunService struct {
	Options []option.RequestOption
}

APIPerformanceRunService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAPIPerformanceRunService method instead.

func NewAPIPerformanceRunService 

func NewAPIPerformanceRunService(opts ...option.RequestOption) (r APIPerformanceRunService)

NewAPIPerformanceRunService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*APIPerformanceRunService) Get 

func (r *APIPerformanceRunService) Get(ctx context.Context, runID string, opts ...option.RequestOption) (res *APIPerformanceRunGetResponse, err error)

Retrieve Run

func (*APIPerformanceRunService) List 

func (r *APIPerformanceRunService) List(ctx context.Context, query APIPerformanceRunListParams, opts ...option.RequestOption) (res *APIPerformanceRunListResponse, err error)

List Operation Runs

type APIPerformanceService 

type APIPerformanceService struct {
	Options          []option.RequestOption
	Platforms        APIPerformancePlatformService
	Interfaces       APIPerformanceInterfaceService
	EvaluationConfig APIPerformanceEvaluationConfigService
	Operations       APIPerformanceOperationService
	OperationPrompts APIPerformanceOperationPromptService
	Runs             APIPerformanceRunService
	Prompts          APIPerformancePromptService
	UseCases         APIPerformanceUseCaseService
}

APIPerformanceService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAPIPerformanceService method instead.

func NewAPIPerformanceService 

func NewAPIPerformanceService(opts ...option.RequestOption) (r APIPerformanceService)

NewAPIPerformanceService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type APIPerformanceUseCaseDeleteResponse 

type APIPerformanceUseCaseDeleteResponse struct {
	Ok bool `json:"ok" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Ok          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceUseCaseDeleteResponse) RawJSON added in v0.2.0 

func (r APIPerformanceUseCaseDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceUseCaseDeleteResponse) UnmarshalJSON added in v0.2.0 

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

type APIPerformanceUseCaseGetResponse 

type APIPerformanceUseCaseGetResponse struct {
	ID          string                                   `json:"id" api:"required"`
	Prompt      string                                   `json:"prompt" api:"required"`
	Category    APIPerformanceUseCaseGetResponseCategory `json:"category" api:"nullable"`
	CreatedAt   string                                   `json:"created_at" api:"nullable"`
	Description string                                   `json:"description" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Prompt      respjson.Field
		Category    respjson.Field
		CreatedAt   respjson.Field
		Description respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceUseCaseGetResponse) RawJSON 

func (r APIPerformanceUseCaseGetResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceUseCaseGetResponse) UnmarshalJSON 

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

type APIPerformanceUseCaseGetResponseCategory 

type APIPerformanceUseCaseGetResponseCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceUseCaseGetResponseCategory) RawJSON 

func (r APIPerformanceUseCaseGetResponseCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceUseCaseGetResponseCategory) UnmarshalJSON 

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

type APIPerformanceUseCaseListResponse 

type APIPerformanceUseCaseListResponse struct {
	ID          string                                    `json:"id" api:"required"`
	Prompt      string                                    `json:"prompt" api:"required"`
	Category    APIPerformanceUseCaseListResponseCategory `json:"category" api:"nullable"`
	CreatedAt   string                                    `json:"created_at" api:"nullable"`
	Description string                                    `json:"description" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Prompt      respjson.Field
		Category    respjson.Field
		CreatedAt   respjson.Field
		Description respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceUseCaseListResponse) RawJSON 

func (r APIPerformanceUseCaseListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceUseCaseListResponse) UnmarshalJSON 

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

type APIPerformanceUseCaseListResponseCategory 

type APIPerformanceUseCaseListResponseCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceUseCaseListResponseCategory) RawJSON 

func (r APIPerformanceUseCaseListResponseCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceUseCaseListResponseCategory) UnmarshalJSON 

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

type APIPerformanceUseCaseNewParams 

type APIPerformanceUseCaseNewParams struct {
	Prompt       string            `json:"prompt" api:"required"`
	CategoryName param.Opt[string] `json:"category_name,omitzero"`
	Description  param.Opt[string] `json:"description,omitzero"`
	// contains filtered or unexported fields
}

func (APIPerformanceUseCaseNewParams) MarshalJSON 

func (r APIPerformanceUseCaseNewParams) MarshalJSON() (data []byte, err error)

func (*APIPerformanceUseCaseNewParams) UnmarshalJSON 

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

type APIPerformanceUseCaseNewResponse 

type APIPerformanceUseCaseNewResponse struct {
	ID          string                                   `json:"id" api:"required"`
	Prompt      string                                   `json:"prompt" api:"required"`
	Category    APIPerformanceUseCaseNewResponseCategory `json:"category" api:"nullable"`
	CreatedAt   string                                   `json:"created_at" api:"nullable"`
	Description string                                   `json:"description" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Prompt      respjson.Field
		Category    respjson.Field
		CreatedAt   respjson.Field
		Description respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceUseCaseNewResponse) RawJSON 

func (r APIPerformanceUseCaseNewResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceUseCaseNewResponse) UnmarshalJSON 

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

type APIPerformanceUseCaseNewResponseCategory 

type APIPerformanceUseCaseNewResponseCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceUseCaseNewResponseCategory) RawJSON 

func (r APIPerformanceUseCaseNewResponseCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceUseCaseNewResponseCategory) UnmarshalJSON 

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

type APIPerformanceUseCaseService 

type APIPerformanceUseCaseService struct {
	Options []option.RequestOption
}

APIPerformanceUseCaseService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAPIPerformanceUseCaseService method instead.

func NewAPIPerformanceUseCaseService 

func NewAPIPerformanceUseCaseService(opts ...option.RequestOption) (r APIPerformanceUseCaseService)

NewAPIPerformanceUseCaseService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*APIPerformanceUseCaseService) Delete 

func (r *APIPerformanceUseCaseService) Delete(ctx context.Context, useCaseID string, opts ...option.RequestOption) (res *APIPerformanceUseCaseDeleteResponse, err error)

Delete Use Case

func (*APIPerformanceUseCaseService) Get 

func (r *APIPerformanceUseCaseService) Get(ctx context.Context, useCaseID string, opts ...option.RequestOption) (res *APIPerformanceUseCaseGetResponse, err error)

Retrieve Use Case

func (*APIPerformanceUseCaseService) List 

func (r *APIPerformanceUseCaseService) List(ctx context.Context, opts ...option.RequestOption) (res *[]APIPerformanceUseCaseListResponse, err error)

List Use Cases

func (*APIPerformanceUseCaseService) New 

func (r *APIPerformanceUseCaseService) New(ctx context.Context, body APIPerformanceUseCaseNewParams, opts ...option.RequestOption) (res *APIPerformanceUseCaseNewResponse, err error)

Create Use Case

func (*APIPerformanceUseCaseService) Update 

func (r *APIPerformanceUseCaseService) Update(ctx context.Context, useCaseID string, body APIPerformanceUseCaseUpdateParams, opts ...option.RequestOption) (res *APIPerformanceUseCaseUpdateResponse, err error)

Update Use Case

type APIPerformanceUseCaseUpdateParams 

type APIPerformanceUseCaseUpdateParams struct {
	CategoryName param.Opt[string] `json:"category_name,omitzero"`
	Description  param.Opt[string] `json:"description,omitzero"`
	Prompt       param.Opt[string] `json:"prompt,omitzero"`
	// contains filtered or unexported fields
}

func (APIPerformanceUseCaseUpdateParams) MarshalJSON 

func (r APIPerformanceUseCaseUpdateParams) MarshalJSON() (data []byte, err error)

func (*APIPerformanceUseCaseUpdateParams) UnmarshalJSON 

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

type APIPerformanceUseCaseUpdateResponse 

type APIPerformanceUseCaseUpdateResponse struct {
	ID          string                                      `json:"id" api:"required"`
	Prompt      string                                      `json:"prompt" api:"required"`
	Category    APIPerformanceUseCaseUpdateResponseCategory `json:"category" api:"nullable"`
	CreatedAt   string                                      `json:"created_at" api:"nullable"`
	Description string                                      `json:"description" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Prompt      respjson.Field
		Category    respjson.Field
		CreatedAt   respjson.Field
		Description respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceUseCaseUpdateResponse) RawJSON 

func (r APIPerformanceUseCaseUpdateResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceUseCaseUpdateResponse) UnmarshalJSON 

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

type APIPerformanceUseCaseUpdateResponseCategory 

type APIPerformanceUseCaseUpdateResponseCategory struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	Slug      string `json:"slug" api:"required"`
	SortOrder int64  `json:"sort_order"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		Slug        respjson.Field
		SortOrder   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (APIPerformanceUseCaseUpdateResponseCategory) RawJSON 

func (r APIPerformanceUseCaseUpdateResponseCategory) RawJSON() string

Returns the unmodified JSON received from the API

func (*APIPerformanceUseCaseUpdateResponseCategory) UnmarshalJSON 

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

type AuthService 

type AuthService struct {
	Options []option.RequestOption
}

AuthService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewAuthService method instead.

func NewAuthService 

func NewAuthService(opts ...option.RequestOption) (r AuthService)

NewAuthService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*AuthService) Status 

func (r *AuthService) Status(ctx context.Context, opts ...option.RequestOption) (res *AuthStatusResponse, err error)

Get Auth Status

type AuthStatusResponse 

type AuthStatusResponse = any

type Client 

type Client struct {
	Options        []option.RequestOption
	Status         StatusService
	Auth           AuthService
	Prompts        PromptService
	APIPerformance APIPerformanceService
}

Client creates a struct with services and top level methods that help with interacting with the Sapient API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r Client)

NewClient generates a new client with the default option read from the environment (SAPIENT_API_KEY, SAPIENT_BASE_URL). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

func (*Client) Delete 

func (r *Client) Delete(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Delete makes a DELETE request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Execute 

func (r *Client) Execute(ctx context.Context, method string, path string, params any, res any, opts ...option.RequestOption) error

Execute makes a request with the given context, method, URL, request params, response, and request options. This is useful for hitting undocumented endpoints while retaining the base URL, auth, retries, and other options from the client.

If a byte slice or an io.Reader is supplied to params, it will be used as-is for the request body.

The params is by default serialized into the body using encoding/json. If your type implements a MarshalJSON function, it will be used instead to serialize the request. If a URLQuery method is implemented, the returned url.Values will be used as query strings to the url.

If your params struct uses param.Field, you must provide either [MarshalJSON], [URLQuery], and/or [MarshalForm] functions. It is undefined behavior to use a struct uses param.Field without specifying how it is serialized.

Any "…Params" object defined in this library can be used as the request argument. Note that 'path' arguments will not be forwarded into the url.

The response body will be deserialized into the res variable, depending on its type:

  • A pointer to a *http.Response is populated by the raw response.
  • A pointer to a byte array will be populated with the contents of the request body.
  • A pointer to any other type uses this library's default JSON decoding, which respects UnmarshalJSON if it is defined on the type.
  • A nil value will not read the response body.

For even greater flexibility, see option.WithResponseInto and option.WithResponseBodyInto.

func (*Client) Get 

func (r *Client) Get(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Get makes a GET request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Patch 

func (r *Client) Patch(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Patch makes a PATCH request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Post 

func (r *Client) Post(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Post makes a POST request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

func (*Client) Put 

func (r *Client) Put(ctx context.Context, path string, params any, res any, opts ...option.RequestOption) error

Put makes a PUT request with the given URL, params, and optionally deserializes to a response. See [Execute] documentation on the params and response.

type Error 

type Error = apierror.Error

type PromptDeleteResponse 

type PromptDeleteResponse struct {
	Ok bool `json:"ok" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Ok          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptDeleteResponse) RawJSON added in v0.2.0 

func (r PromptDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptDeleteResponse) UnmarshalJSON added in v0.2.0 

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

type PromptEstimateCostResponse added in v0.2.0 

type PromptEstimateCostResponse struct {
	Estimates    map[string]PromptEstimateCostResponseEstimate `json:"estimates" api:"required"`
	TotalCredits int64                                         `json:"total_credits" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Estimates    respjson.Field
		TotalCredits respjson.Field
		ExtraFields  map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptEstimateCostResponse) RawJSON added in v0.2.0 

func (r PromptEstimateCostResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptEstimateCostResponse) UnmarshalJSON added in v0.2.0 

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

type PromptEstimateCostResponseEstimate added in v0.2.0 

type PromptEstimateCostResponseEstimate struct {
	CreditsPerPrompt int64 `json:"credits_per_prompt" api:"required"`
	PromptCount      int64 `json:"prompt_count" api:"required"`
	TotalCredits     int64 `json:"total_credits" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		CreditsPerPrompt respjson.Field
		PromptCount      respjson.Field
		TotalCredits     respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptEstimateCostResponseEstimate) RawJSON added in v0.2.0 

func (r PromptEstimateCostResponseEstimate) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptEstimateCostResponseEstimate) UnmarshalJSON added in v0.2.0 

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

type PromptGetResponse 

type PromptGetResponse struct {
	ID         string                      `json:"id" api:"required"`
	Text       string                      `json:"text" api:"required"`
	TopicID    string                      `json:"topic_id" api:"required"`
	CreatedAt  string                      `json:"created_at" api:"nullable"`
	IsActive   bool                        `json:"is_active"`
	LanguageID string                      `json:"language_id" api:"nullable"`
	Platforms  []PromptGetResponsePlatform `json:"platforms"`
	RegionID   string                      `json:"region_id" api:"nullable"`
	// Any of "active", "inactive", "archived".
	Status    PromptGetResponseStatus `json:"status" api:"nullable"`
	Tags      []PromptGetResponseTag  `json:"tags"`
	Topic     PromptGetResponseTopic  `json:"topic" api:"nullable"`
	UpdatedAt string                  `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Text        respjson.Field
		TopicID     respjson.Field
		CreatedAt   respjson.Field
		IsActive    respjson.Field
		LanguageID  respjson.Field
		Platforms   respjson.Field
		RegionID    respjson.Field
		Status      respjson.Field
		Tags        respjson.Field
		Topic       respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptGetResponse) RawJSON 

func (r PromptGetResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptGetResponse) UnmarshalJSON 

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

type PromptGetResponsePlatform 

type PromptGetResponsePlatform struct {
	ID   string `json:"id" api:"required"`
	Name string `json:"name" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptGetResponsePlatform) RawJSON 

func (r PromptGetResponsePlatform) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptGetResponsePlatform) UnmarshalJSON 

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

type PromptGetResponseStatus 

type PromptGetResponseStatus string
const (
	PromptGetResponseStatusActive   PromptGetResponseStatus = "active"
	PromptGetResponseStatusInactive PromptGetResponseStatus = "inactive"
	PromptGetResponseStatusArchived PromptGetResponseStatus = "archived"
)

type PromptGetResponseTag 

type PromptGetResponseTag struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptGetResponseTag) RawJSON 

func (r PromptGetResponseTag) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptGetResponseTag) UnmarshalJSON 

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

type PromptGetResponseTopic 

type PromptGetResponseTopic struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptGetResponseTopic) RawJSON 

func (r PromptGetResponseTopic) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptGetResponseTopic) UnmarshalJSON 

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

type PromptListParams 

type PromptListParams struct {
	IsActive        param.Opt[bool]   `query:"is_active,omitzero" json:"-"`
	Status          param.Opt[string] `query:"status,omitzero" json:"-"`
	TopicID         param.Opt[string] `query:"topic_id,omitzero" json:"-"`
	IncludeArchived param.Opt[bool]   `query:"include_archived,omitzero" json:"-"`
	// contains filtered or unexported fields
}

func (PromptListParams) URLQuery 

func (r PromptListParams) URLQuery() (v url.Values, err error)

URLQuery serializes PromptListParams's query parameters as `url.Values`.

type PromptListResponse 

type PromptListResponse struct {
	Count int64                    `json:"count" api:"required"`
	Data  []PromptListResponseData `json:"data" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Count       respjson.Field
		Data        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptListResponse) RawJSON 

func (r PromptListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptListResponse) UnmarshalJSON 

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

type PromptListResponseData 

type PromptListResponseData struct {
	ID         string                           `json:"id" api:"required"`
	Text       string                           `json:"text" api:"required"`
	TopicID    string                           `json:"topic_id" api:"required"`
	CreatedAt  string                           `json:"created_at" api:"nullable"`
	IsActive   bool                             `json:"is_active"`
	LanguageID string                           `json:"language_id" api:"nullable"`
	Platforms  []PromptListResponseDataPlatform `json:"platforms"`
	RegionID   string                           `json:"region_id" api:"nullable"`
	// Any of "active", "inactive", "archived".
	Status    string                      `json:"status" api:"nullable"`
	Tags      []PromptListResponseDataTag `json:"tags"`
	Topic     PromptListResponseDataTopic `json:"topic" api:"nullable"`
	UpdatedAt string                      `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Text        respjson.Field
		TopicID     respjson.Field
		CreatedAt   respjson.Field
		IsActive    respjson.Field
		LanguageID  respjson.Field
		Platforms   respjson.Field
		RegionID    respjson.Field
		Status      respjson.Field
		Tags        respjson.Field
		Topic       respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptListResponseData) RawJSON 

func (r PromptListResponseData) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptListResponseData) UnmarshalJSON 

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

type PromptListResponseDataPlatform 

type PromptListResponseDataPlatform struct {
	ID   string `json:"id" api:"required"`
	Name string `json:"name" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptListResponseDataPlatform) RawJSON 

func (r PromptListResponseDataPlatform) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptListResponseDataPlatform) UnmarshalJSON 

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

type PromptListResponseDataTag 

type PromptListResponseDataTag struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptListResponseDataTag) RawJSON 

func (r PromptListResponseDataTag) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptListResponseDataTag) UnmarshalJSON 

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

type PromptListResponseDataTopic 

type PromptListResponseDataTopic struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptListResponseDataTopic) RawJSON 

func (r PromptListResponseDataTopic) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptListResponseDataTopic) UnmarshalJSON 

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

type PromptNewParams 

type PromptNewParams struct {
	Text        string   `json:"text" api:"required"`
	TopicID     string   `json:"topic_id" api:"required"`
	PlatformIDs []string `json:"platform_ids,omitzero"`
	// contains filtered or unexported fields
}

func (PromptNewParams) MarshalJSON 

func (r PromptNewParams) MarshalJSON() (data []byte, err error)

func (*PromptNewParams) UnmarshalJSON 

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

type PromptNewResponse 

type PromptNewResponse struct {
	ID         string                      `json:"id" api:"required"`
	Text       string                      `json:"text" api:"required"`
	TopicID    string                      `json:"topic_id" api:"required"`
	CreatedAt  string                      `json:"created_at" api:"nullable"`
	IsActive   bool                        `json:"is_active"`
	LanguageID string                      `json:"language_id" api:"nullable"`
	Platforms  []PromptNewResponsePlatform `json:"platforms"`
	RegionID   string                      `json:"region_id" api:"nullable"`
	// Any of "active", "inactive", "archived".
	Status    PromptNewResponseStatus `json:"status" api:"nullable"`
	Tags      []PromptNewResponseTag  `json:"tags"`
	Topic     PromptNewResponseTopic  `json:"topic" api:"nullable"`
	UpdatedAt string                  `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Text        respjson.Field
		TopicID     respjson.Field
		CreatedAt   respjson.Field
		IsActive    respjson.Field
		LanguageID  respjson.Field
		Platforms   respjson.Field
		RegionID    respjson.Field
		Status      respjson.Field
		Tags        respjson.Field
		Topic       respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptNewResponse) RawJSON 

func (r PromptNewResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptNewResponse) UnmarshalJSON 

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

type PromptNewResponsePlatform 

type PromptNewResponsePlatform struct {
	ID   string `json:"id" api:"required"`
	Name string `json:"name" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptNewResponsePlatform) RawJSON 

func (r PromptNewResponsePlatform) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptNewResponsePlatform) UnmarshalJSON 

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

type PromptNewResponseStatus 

type PromptNewResponseStatus string
const (
	PromptNewResponseStatusActive   PromptNewResponseStatus = "active"
	PromptNewResponseStatusInactive PromptNewResponseStatus = "inactive"
	PromptNewResponseStatusArchived PromptNewResponseStatus = "archived"
)

type PromptNewResponseTag 

type PromptNewResponseTag struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptNewResponseTag) RawJSON 

func (r PromptNewResponseTag) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptNewResponseTag) UnmarshalJSON 

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

type PromptNewResponseTopic 

type PromptNewResponseTopic struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptNewResponseTopic) RawJSON 

func (r PromptNewResponseTopic) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptNewResponseTopic) UnmarshalJSON 

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

type PromptPlatformListResponse 

type PromptPlatformListResponse struct {
	ID               string `json:"id" api:"required"`
	CreditsPerPrompt int64  `json:"credits_per_prompt" api:"required"`
	Name             string `json:"name" api:"required"`
	Model            string `json:"model" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID               respjson.Field
		CreditsPerPrompt respjson.Field
		Name             respjson.Field
		Model            respjson.Field
		ExtraFields      map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptPlatformListResponse) RawJSON added in v0.2.0 

func (r PromptPlatformListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptPlatformListResponse) UnmarshalJSON added in v0.2.0 

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

type PromptPlatformService 

type PromptPlatformService struct {
	Options []option.RequestOption
}

PromptPlatformService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPromptPlatformService method instead.

func NewPromptPlatformService 

func NewPromptPlatformService(opts ...option.RequestOption) (r PromptPlatformService)

NewPromptPlatformService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*PromptPlatformService) List 

func (r *PromptPlatformService) List(ctx context.Context, opts ...option.RequestOption) (res *[]PromptPlatformListResponse, err error)

List Platforms

type PromptService 

type PromptService struct {
	Options   []option.RequestOption
	Topics    PromptTopicService
	Platforms PromptPlatformService
}

PromptService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPromptService method instead.

func NewPromptService 

func NewPromptService(opts ...option.RequestOption) (r PromptService)

NewPromptService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*PromptService) Delete 

func (r *PromptService) Delete(ctx context.Context, promptID string, opts ...option.RequestOption) (res *PromptDeleteResponse, err error)

Delete Prompt

func (*PromptService) EstimateCost added in v0.2.0 

func (r *PromptService) EstimateCost(ctx context.Context, opts ...option.RequestOption) (res *PromptEstimateCostResponse, err error)

Estimate Prompt Cost

func (*PromptService) Get 

func (r *PromptService) Get(ctx context.Context, promptID string, opts ...option.RequestOption) (res *PromptGetResponse, err error)

Retrieve Prompt

func (*PromptService) List 

func (r *PromptService) List(ctx context.Context, query PromptListParams, opts ...option.RequestOption) (res *PromptListResponse, err error)

List Prompts

func (*PromptService) New 

func (r *PromptService) New(ctx context.Context, body PromptNewParams, opts ...option.RequestOption) (res *PromptNewResponse, err error)

Create Prompt

func (*PromptService) Update 

func (r *PromptService) Update(ctx context.Context, promptID string, body PromptUpdateParams, opts ...option.RequestOption) (res *PromptUpdateResponse, err error)

Update Prompt

type PromptTopicDeleteResponse 

type PromptTopicDeleteResponse struct {
	Ok bool `json:"ok" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		Ok          respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptTopicDeleteResponse) RawJSON added in v0.2.0 

func (r PromptTopicDeleteResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptTopicDeleteResponse) UnmarshalJSON added in v0.2.0 

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

type PromptTopicListResponse 

type PromptTopicListResponse struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptTopicListResponse) RawJSON 

func (r PromptTopicListResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptTopicListResponse) UnmarshalJSON 

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

type PromptTopicNewParams 

type PromptTopicNewParams struct {
	Name string `json:"name" api:"required"`
	// contains filtered or unexported fields
}

func (PromptTopicNewParams) MarshalJSON 

func (r PromptTopicNewParams) MarshalJSON() (data []byte, err error)

func (*PromptTopicNewParams) UnmarshalJSON 

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

type PromptTopicNewResponse 

type PromptTopicNewResponse struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptTopicNewResponse) RawJSON 

func (r PromptTopicNewResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptTopicNewResponse) UnmarshalJSON 

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

type PromptTopicService 

type PromptTopicService struct {
	Options []option.RequestOption
}

PromptTopicService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPromptTopicService method instead.

func NewPromptTopicService 

func NewPromptTopicService(opts ...option.RequestOption) (r PromptTopicService)

NewPromptTopicService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*PromptTopicService) Delete 

func (r *PromptTopicService) Delete(ctx context.Context, topicID string, opts ...option.RequestOption) (res *PromptTopicDeleteResponse, err error)

Delete Topic

func (*PromptTopicService) List 

func (r *PromptTopicService) List(ctx context.Context, opts ...option.RequestOption) (res *[]PromptTopicListResponse, err error)

List Topics

func (*PromptTopicService) New 

func (r *PromptTopicService) New(ctx context.Context, body PromptTopicNewParams, opts ...option.RequestOption) (res *PromptTopicNewResponse, err error)

Create Topic

func (*PromptTopicService) Update 

func (r *PromptTopicService) Update(ctx context.Context, topicID string, body PromptTopicUpdateParams, opts ...option.RequestOption) (res *PromptTopicUpdateResponse, err error)

Update Topic

type PromptTopicUpdateParams 

type PromptTopicUpdateParams struct {
	Name string `json:"name" api:"required"`
	// contains filtered or unexported fields
}

func (PromptTopicUpdateParams) MarshalJSON 

func (r PromptTopicUpdateParams) MarshalJSON() (data []byte, err error)

func (*PromptTopicUpdateParams) UnmarshalJSON 

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

type PromptTopicUpdateResponse 

type PromptTopicUpdateResponse struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptTopicUpdateResponse) RawJSON 

func (r PromptTopicUpdateResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptTopicUpdateResponse) UnmarshalJSON 

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

type PromptUpdateParams 

type PromptUpdateParams struct {
	IsActive    param.Opt[bool]   `json:"is_active,omitzero"`
	Text        param.Opt[string] `json:"text,omitzero"`
	TopicID     param.Opt[string] `json:"topic_id,omitzero"`
	PlatformIDs []string          `json:"platform_ids,omitzero"`
	// contains filtered or unexported fields
}

func (PromptUpdateParams) MarshalJSON 

func (r PromptUpdateParams) MarshalJSON() (data []byte, err error)

func (*PromptUpdateParams) UnmarshalJSON 

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

type PromptUpdateResponse 

type PromptUpdateResponse struct {
	ID         string                         `json:"id" api:"required"`
	Text       string                         `json:"text" api:"required"`
	TopicID    string                         `json:"topic_id" api:"required"`
	CreatedAt  string                         `json:"created_at" api:"nullable"`
	IsActive   bool                           `json:"is_active"`
	LanguageID string                         `json:"language_id" api:"nullable"`
	Platforms  []PromptUpdateResponsePlatform `json:"platforms"`
	RegionID   string                         `json:"region_id" api:"nullable"`
	// Any of "active", "inactive", "archived".
	Status    PromptUpdateResponseStatus `json:"status" api:"nullable"`
	Tags      []PromptUpdateResponseTag  `json:"tags"`
	Topic     PromptUpdateResponseTopic  `json:"topic" api:"nullable"`
	UpdatedAt string                     `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Text        respjson.Field
		TopicID     respjson.Field
		CreatedAt   respjson.Field
		IsActive    respjson.Field
		LanguageID  respjson.Field
		Platforms   respjson.Field
		RegionID    respjson.Field
		Status      respjson.Field
		Tags        respjson.Field
		Topic       respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptUpdateResponse) RawJSON 

func (r PromptUpdateResponse) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptUpdateResponse) UnmarshalJSON 

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

type PromptUpdateResponsePlatform 

type PromptUpdateResponsePlatform struct {
	ID   string `json:"id" api:"required"`
	Name string `json:"name" api:"required"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptUpdateResponsePlatform) RawJSON 

func (r PromptUpdateResponsePlatform) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptUpdateResponsePlatform) UnmarshalJSON 

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

type PromptUpdateResponseStatus 

type PromptUpdateResponseStatus string
const (
	PromptUpdateResponseStatusActive   PromptUpdateResponseStatus = "active"
	PromptUpdateResponseStatusInactive PromptUpdateResponseStatus = "inactive"
	PromptUpdateResponseStatusArchived PromptUpdateResponseStatus = "archived"
)

type PromptUpdateResponseTag 

type PromptUpdateResponseTag struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptUpdateResponseTag) RawJSON 

func (r PromptUpdateResponseTag) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptUpdateResponseTag) UnmarshalJSON 

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

type PromptUpdateResponseTopic 

type PromptUpdateResponseTopic struct {
	ID        string `json:"id" api:"required"`
	Name      string `json:"name" api:"required"`
	CreatedAt string `json:"created_at" api:"nullable"`
	UpdatedAt string `json:"updated_at" api:"nullable"`
	// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
	JSON struct {
		ID          respjson.Field
		Name        respjson.Field
		CreatedAt   respjson.Field
		UpdatedAt   respjson.Field
		ExtraFields map[string]respjson.Field
		// contains filtered or unexported fields
	} `json:"-"`
}

func (PromptUpdateResponseTopic) RawJSON 

func (r PromptUpdateResponseTopic) RawJSON() string

Returns the unmodified JSON received from the API

func (*PromptUpdateResponseTopic) UnmarshalJSON 

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

type StatusGetResponse 

type StatusGetResponse = any

type StatusService 

type StatusService struct {
	Options []option.RequestOption
}

StatusService contains methods and other services that help with interacting with the Sapient API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewStatusService method instead.

func NewStatusService 

func NewStatusService(opts ...option.RequestOption) (r StatusService)

NewStatusService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*StatusService) Get 

func (r *StatusService) Get(ctx context.Context, opts ...option.RequestOption) (res *StatusGetResponse, err error)

Get Status

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
encoding/json
Package json implements encoding and decoding of JSON as defined in RFC 7159.
 Package json implements encoding and decoding of JSON as defined in RFC 7159.
encoding/json/sentinel
encoding/json/shims
This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
 This package provides shims over Go 1.2{2,3} APIs which are missing from Go 1.22, and used by the Go 1.24 encoding/json package.
paramutil
requestconfig
testutil
packages
param
respjson
shared
constant

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.