zep

package module
v2.6.0 Latest Latest
Warning

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

 Go to latest Published: Mar 10, 2025 License: Apache-2.0 Imports: 7 Imported by: 0

README

Zep Go Library

Zep Logo

Zep: Long-Term Memory for ‍AI Assistants.

Recall, understand, and extract data from chat histories. Power personalized AI experiences.


Chat on Discord Twitter Follow Go Reference Go Report Card CI CI

Documentation | LangChain | Discord
www.getzep.com

The Zep Go library provides convenient access to the Zep Cloud API from Go.

Requirements

This module requires Go version >= 1.13.

Installation

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

go get github.com/getzep/zep-go/v2

Initialize Client

import (
  "github.com/getzep/zep-go/v2"
  zepclient "github.com/getzep/zep-go/v2/client"
  "github.com/getzep/zep-go/v2/option"
)

client := zepclient.NewClient(
  // this api key is `api_secret` line from zep.yaml of your local server or your Zep cloud api-key
  option.WithAPIKey("<YOUR_API_KEY>"),
  // use this to connect to your Zep server locally, not necessary for Zep Cloud
  option.WithBaseURL("http://localhost:8000/api/v2"), 
)

Add Memory

_, err = client.Memory.Add(ctx, "session_id", &zep.AddMemoryRequest{
    Messages: []*zep.Message{
        {
            Role:     zep.String("customer"),
            Content:  zep.String("Hello, can I buy some shoes?"),
            RoleType: zep.RoleTypeUserRole.Ptr(),
        },
    },
})

Get Memory

memory, err := client.Memory.Get(ctx, "session_id", nil)

Optionals

This library models optional primitives and enum types as pointers. This is primarily meant to distinguish default zero values from explicit values (e.g. false for bool and "" for string). A collection of helper functions are provided to easily map a primitive or enum to its pointer-equivalent (e.g. zep.Int).

Request Options

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

client := zepclient.NewClient(
  option.WithAPIKey("<YOUR_API_KEY>"),
  option.WithHTTPClient(
    &http.Client{
      Timeout: 5 * time.Second,
    },
  ),
)

These request options can either be specified on the client so that they're applied on every request (shown above), or for an individual request like so:

_, _ = client.Memory.Get(ctx, "session_id", &zep.MemoryGetRequest{}, option.WithAPIKey("<YOUR_API_KEY>"))

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

Automatic Retries

The Zep Go client is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retriable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

A request is deemed retriable when any of the following HTTP status codes is returned:

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (Internal Server Errors)

You can use the option.WithMaxAttempts option to configure the maximum retry limit to your liking. For example, if you want to disable retries for the client entirely, you can set this value to 1 like so:

client := zepclient.NewClient(
  option.WithMaxAttempts(1),
)

This can be done for an individual request, too:

_, _ = client.Memory.Get(ctx, "session_id", &zep.MemoryGetRequest{}, option.WithMaxAttempts(1))

Errors

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

_, err := client.Memory.Get(ctx, "session_id", &zep.MemoryGetRequest{})
if err != nil {
  if badRequestErr, ok := err.(*zep.BadRequestError);
    // Do something with the bad request ...
  }
  return err
}

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

_, err := client.Memory.Get(ctx, "session_id", &zep.MemoryGetRequest{})
if err != nil {
  var badRequestErr *zep.BadRequestError
  if errors.As(err, badRequestErr) {
    // Do something with the bad request ...
  }
  return err
}

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

_, err := client.Memory.Get(ctx, "session_id", &zep.MemoryGetRequest{})
if err != nil {
  return fmt.Errorf("failed to get memory: %w", err)
}

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README.md are always very welcome!

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Environments = struct {
	Default string
}{
	Default: "https://api.getzep.com/api/v2",
}

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

Functions

func Bool 

func Bool(b bool) *bool

Bool returns a pointer to the given bool value.

func Byte 

func Byte(b byte) *byte

Byte returns a pointer to the given byte value.

func Complex128 

func Complex128(c complex128) *complex128

Complex128 returns a pointer to the given complex128 value.

func Complex64 

func Complex64(c complex64) *complex64

Complex64 returns a pointer to the given complex64 value.

func Float32 

func Float32(f float32) *float32

Float32 returns a pointer to the given float32 value.

func Float64 

func Float64(f float64) *float64

Float64 returns a pointer to the given float64 value.

func Int 

func Int(i int) *int

Int returns a pointer to the given int value.

func Int16 

func Int16(i int16) *int16

Int16 returns a pointer to the given int16 value.

func Int32 

func Int32(i int32) *int32

Int32 returns a pointer to the given int32 value.

func Int64 

func Int64(i int64) *int64

Int64 returns a pointer to the given int64 value.

func Int8 

func Int8(i int8) *int8

Int8 returns a pointer to the given int8 value.

func MustParseDate 

func MustParseDate(date string) time.Time

MustParseDate attempts to parse the given string as a date time.Time, and panics upon failure.

func MustParseDateTime 

func MustParseDateTime(datetime string) time.Time

MustParseDateTime attempts to parse the given string as a datetime time.Time, and panics upon failure.

func Rune 

func Rune(r rune) *rune

Rune returns a pointer to the given rune value.

func String 

func String(s string) *string

String returns a pointer to the given string value.

func Time 

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

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

func UUID 

func UUID(u uuid.UUID) *uuid.UUID

UUID returns a pointer to the given uuid.UUID value.

func Uint 

func Uint(u uint) *uint

Uint returns a pointer to the given uint value.

func Uint16 

func Uint16(u uint16) *uint16

Uint16 returns a pointer to the given uint16 value.

func Uint32 

func Uint32(u uint32) *uint32

Uint32 returns a pointer to the given uint32 value.

func Uint64 

func Uint64(u uint64) *uint64

Uint64 returns a pointer to the given uint64 value.

func Uint8 

func Uint8(u uint8) *uint8

Uint8 returns a pointer to the given uint8 value.

func Uintptr 

func Uintptr(u uintptr) *uintptr

Uintptr returns a pointer to the given uintptr value.

Types

type APIError 

type APIError struct {
	Message *string `json:"message,omitempty" url:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*APIError) GetExtraProperties 

func (a *APIError) GetExtraProperties() map[string]interface{}

func (*APIError) GetMessage added in v2.3.1 

func (a *APIError) GetMessage() *string

func (*APIError) String 

func (a *APIError) String() string

func (*APIError) UnmarshalJSON 

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

type AddDataRequest 

type AddDataRequest struct {
	Data    *string        `json:"data,omitempty" url:"-"`
	GroupID *string        `json:"group_id,omitempty" url:"-"`
	Type    *GraphDataType `json:"type,omitempty" url:"-"`
	UserID  *string        `json:"user_id,omitempty" url:"-"`
}

type AddFactsRequest 

type AddFactsRequest struct {
	Facts []*NewFact `json:"facts,omitempty" url:"-"`
}

type AddMemoryRequest 

type AddMemoryRequest struct {
	// Deprecated
	FactInstruction *string `json:"fact_instruction,omitempty" url:"-"`
	// Optional list of role types to ignore when adding messages to graph memory.
	// The message itself will still be added retained and used as context for messages
	// that are added to a user's graph.
	IgnoreRoles []RoleType `json:"ignore_roles,omitempty" url:"-"`
	// A list of message objects, where each message contains a role and content.
	Messages []*Message `json:"messages,omitempty" url:"-"`
	// Optionally return memory context relevant to the most recent messages.
	ReturnContext *bool `json:"return_context,omitempty" url:"-"`
	// Deprecated
	SummaryInstruction *string `json:"summary_instruction,omitempty" url:"-"`
}

type AddMemoryResponse added in v2.2.0 

type AddMemoryResponse struct {
	Context *string `json:"context,omitempty" url:"context,omitempty"`
	// contains filtered or unexported fields
}

func (*AddMemoryResponse) GetContext added in v2.3.1 

func (a *AddMemoryResponse) GetContext() *string

func (*AddMemoryResponse) GetExtraProperties added in v2.2.0 

func (a *AddMemoryResponse) GetExtraProperties() map[string]interface{}

func (*AddMemoryResponse) String added in v2.2.0 

func (a *AddMemoryResponse) String() string

func (*AddMemoryResponse) UnmarshalJSON added in v2.2.0 

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

type AddTripleRequest added in v2.4.0 

type AddTripleRequest struct {
	// The timestamp of the message
	CreatedAt *string `json:"created_at,omitempty" url:"-"`
	// The time (if any) at which the edge expires
	ExpiredAt *string `json:"expired_at,omitempty" url:"-"`
	// The fact relating the two nodes that this edge represents
	Fact string `json:"fact" url:"-"`
	// The name of the edge to add. Should be all caps using snake case (eg RELATES_TO)
	FactName string `json:"fact_name" url:"-"`
	// The uuid of the edge to add
	FactUUID *string `json:"fact_uuid,omitempty" url:"-"`
	GroupID  *string `json:"group_id,omitempty" url:"-"`
	// The time (if any) at which the fact stops being true
	InvalidAt *string `json:"invalid_at,omitempty" url:"-"`
	// The name of the source node to add
	SourceNodeName *string `json:"source_node_name,omitempty" url:"-"`
	// The summary of the source node to add
	SourceNodeSummary *string `json:"source_node_summary,omitempty" url:"-"`
	// The source node uuid
	SourceNodeUUID *string `json:"source_node_uuid,omitempty" url:"-"`
	// The name of the target node to add
	TargetNodeName string `json:"target_node_name" url:"-"`
	// The summary of the target node to add
	TargetNodeSummary *string `json:"target_node_summary,omitempty" url:"-"`
	// The target node uuid
	TargetNodeUUID *string `json:"target_node_uuid,omitempty" url:"-"`
	UserID         *string `json:"user_id,omitempty" url:"-"`
	// The time at which the fact becomes true
	ValidAt *string `json:"valid_at,omitempty" url:"-"`
}

type AddTripleResponse added in v2.4.0 

type AddTripleResponse struct {
	Edge       *EntityEdge `json:"edge,omitempty" url:"edge,omitempty"`
	SourceNode *EntityNode `json:"source_node,omitempty" url:"source_node,omitempty"`
	TargetNode *EntityNode `json:"target_node,omitempty" url:"target_node,omitempty"`
	// contains filtered or unexported fields
}

func (*AddTripleResponse) GetEdge added in v2.5.0 

func (a *AddTripleResponse) GetEdge() *EntityEdge

func (*AddTripleResponse) GetExtraProperties added in v2.5.0 

func (a *AddTripleResponse) GetExtraProperties() map[string]interface{}

func (*AddTripleResponse) GetSourceNode added in v2.5.0 

func (a *AddTripleResponse) GetSourceNode() *EntityNode

func (*AddTripleResponse) GetTargetNode added in v2.5.0 

func (a *AddTripleResponse) GetTargetNode() *EntityNode

func (*AddTripleResponse) String added in v2.5.0 

func (a *AddTripleResponse) String() string

func (*AddTripleResponse) UnmarshalJSON added in v2.5.0 

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

type AddedFact 

type AddedFact = interface{}

type ApidataDocument 

type ApidataDocument struct {
	Content    *string                `json:"content,omitempty" url:"content,omitempty"`
	CreatedAt  *string                `json:"created_at,omitempty" url:"created_at,omitempty"`
	DocumentID *string                `json:"document_id,omitempty" url:"document_id,omitempty"`
	Embedding  []float64              `json:"embedding,omitempty" url:"embedding,omitempty"`
	IsEmbedded *bool                  `json:"is_embedded,omitempty" url:"is_embedded,omitempty"`
	Metadata   map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	UpdatedAt  *string                `json:"updated_at,omitempty" url:"updated_at,omitempty"`
	UUID       *string                `json:"uuid,omitempty" url:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*ApidataDocument) GetContent added in v2.3.1 

func (a *ApidataDocument) GetContent() *string

func (*ApidataDocument) GetCreatedAt added in v2.3.1 

func (a *ApidataDocument) GetCreatedAt() *string

func (*ApidataDocument) GetDocumentID added in v2.3.1 

func (a *ApidataDocument) GetDocumentID() *string

func (*ApidataDocument) GetEmbedding added in v2.3.1 

func (a *ApidataDocument) GetEmbedding() []float64

func (*ApidataDocument) GetExtraProperties 

func (a *ApidataDocument) GetExtraProperties() map[string]interface{}

func (*ApidataDocument) GetIsEmbedded added in v2.3.1 

func (a *ApidataDocument) GetIsEmbedded() *bool

func (*ApidataDocument) GetMetadata added in v2.3.1 

func (a *ApidataDocument) GetMetadata() map[string]interface{}

func (*ApidataDocument) GetUUID added in v2.3.1 

func (a *ApidataDocument) GetUUID() *string

func (*ApidataDocument) GetUpdatedAt added in v2.3.1 

func (a *ApidataDocument) GetUpdatedAt() *string

func (*ApidataDocument) String 

func (a *ApidataDocument) String() string

func (*ApidataDocument) UnmarshalJSON 

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

type ApidataDocumentCollection 

type ApidataDocumentCollection struct {
	CreatedAt             *string                `json:"created_at,omitempty" url:"created_at,omitempty"`
	Description           *string                `json:"description,omitempty" url:"description,omitempty"`
	DocumentCount         *int                   `json:"document_count,omitempty" url:"document_count,omitempty"`
	DocumentEmbeddedCount *int                   `json:"document_embedded_count,omitempty" url:"document_embedded_count,omitempty"`
	EmbeddingDimensions   *int                   `json:"embedding_dimensions,omitempty" url:"embedding_dimensions,omitempty"`
	EmbeddingModelName    *string                `json:"embedding_model_name,omitempty" url:"embedding_model_name,omitempty"`
	IsAutoEmbedded        *bool                  `json:"is_auto_embedded,omitempty" url:"is_auto_embedded,omitempty"`
	IsIndexed             *bool                  `json:"is_indexed,omitempty" url:"is_indexed,omitempty"`
	IsNormalized          *bool                  `json:"is_normalized,omitempty" url:"is_normalized,omitempty"`
	Metadata              map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Name                  *string                `json:"name,omitempty" url:"name,omitempty"`
	UpdatedAt             *string                `json:"updated_at,omitempty" url:"updated_at,omitempty"`
	UUID                  *string                `json:"uuid,omitempty" url:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*ApidataDocumentCollection) GetCreatedAt added in v2.3.1 

func (a *ApidataDocumentCollection) GetCreatedAt() *string

func (*ApidataDocumentCollection) GetDescription added in v2.3.1 

func (a *ApidataDocumentCollection) GetDescription() *string

func (*ApidataDocumentCollection) GetDocumentCount added in v2.3.1 

func (a *ApidataDocumentCollection) GetDocumentCount() *int

func (*ApidataDocumentCollection) GetDocumentEmbeddedCount added in v2.3.1 

func (a *ApidataDocumentCollection) GetDocumentEmbeddedCount() *int

func (*ApidataDocumentCollection) GetEmbeddingDimensions added in v2.3.1 

func (a *ApidataDocumentCollection) GetEmbeddingDimensions() *int

func (*ApidataDocumentCollection) GetEmbeddingModelName added in v2.3.1 

func (a *ApidataDocumentCollection) GetEmbeddingModelName() *string

func (*ApidataDocumentCollection) GetExtraProperties 

func (a *ApidataDocumentCollection) GetExtraProperties() map[string]interface{}

func (*ApidataDocumentCollection) GetIsAutoEmbedded added in v2.3.1 

func (a *ApidataDocumentCollection) GetIsAutoEmbedded() *bool

func (*ApidataDocumentCollection) GetIsIndexed added in v2.3.1 

func (a *ApidataDocumentCollection) GetIsIndexed() *bool

func (*ApidataDocumentCollection) GetIsNormalized added in v2.3.1 

func (a *ApidataDocumentCollection) GetIsNormalized() *bool

func (*ApidataDocumentCollection) GetMetadata added in v2.3.1 

func (a *ApidataDocumentCollection) GetMetadata() map[string]interface{}

func (*ApidataDocumentCollection) GetName added in v2.3.1 

func (a *ApidataDocumentCollection) GetName() *string

func (*ApidataDocumentCollection) GetUUID added in v2.3.1 

func (a *ApidataDocumentCollection) GetUUID() *string

func (*ApidataDocumentCollection) GetUpdatedAt added in v2.3.1 

func (a *ApidataDocumentCollection) GetUpdatedAt() *string

func (*ApidataDocumentCollection) String 

func (a *ApidataDocumentCollection) String() string

func (*ApidataDocumentCollection) UnmarshalJSON 

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

type ApidataDocumentSearchResponse 

type ApidataDocumentSearchResponse struct {
	CurrentPage *int                        `json:"current_page,omitempty" url:"current_page,omitempty"`
	QueryVector []float64                   `json:"query_vector,omitempty" url:"query_vector,omitempty"`
	ResultCount *int                        `json:"result_count,omitempty" url:"result_count,omitempty"`
	Results     []*ApidataDocumentWithScore `json:"results,omitempty" url:"results,omitempty"`
	TotalPages  *int                        `json:"total_pages,omitempty" url:"total_pages,omitempty"`
	// contains filtered or unexported fields
}

func (*ApidataDocumentSearchResponse) GetCurrentPage added in v2.3.1 

func (a *ApidataDocumentSearchResponse) GetCurrentPage() *int

func (*ApidataDocumentSearchResponse) GetExtraProperties 

func (a *ApidataDocumentSearchResponse) GetExtraProperties() map[string]interface{}

func (*ApidataDocumentSearchResponse) GetQueryVector added in v2.3.1 

func (a *ApidataDocumentSearchResponse) GetQueryVector() []float64

func (*ApidataDocumentSearchResponse) GetResultCount added in v2.3.1 

func (a *ApidataDocumentSearchResponse) GetResultCount() *int

func (*ApidataDocumentSearchResponse) GetResults added in v2.3.1 

func (a *ApidataDocumentSearchResponse) GetResults() []*ApidataDocumentWithScore

func (*ApidataDocumentSearchResponse) GetTotalPages added in v2.3.1 

func (a *ApidataDocumentSearchResponse) GetTotalPages() *int

func (*ApidataDocumentSearchResponse) String 

func (a *ApidataDocumentSearchResponse) String() string

func (*ApidataDocumentSearchResponse) UnmarshalJSON 

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

type ApidataDocumentWithScore 

type ApidataDocumentWithScore struct {
	Content    *string                `json:"content,omitempty" url:"content,omitempty"`
	CreatedAt  *string                `json:"created_at,omitempty" url:"created_at,omitempty"`
	DocumentID *string                `json:"document_id,omitempty" url:"document_id,omitempty"`
	Embedding  []float64              `json:"embedding,omitempty" url:"embedding,omitempty"`
	IsEmbedded *bool                  `json:"is_embedded,omitempty" url:"is_embedded,omitempty"`
	Metadata   map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Score      *float64               `json:"score,omitempty" url:"score,omitempty"`
	UpdatedAt  *string                `json:"updated_at,omitempty" url:"updated_at,omitempty"`
	UUID       *string                `json:"uuid,omitempty" url:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*ApidataDocumentWithScore) GetContent added in v2.3.1 

func (a *ApidataDocumentWithScore) GetContent() *string

func (*ApidataDocumentWithScore) GetCreatedAt added in v2.3.1 

func (a *ApidataDocumentWithScore) GetCreatedAt() *string

func (*ApidataDocumentWithScore) GetDocumentID added in v2.3.1 

func (a *ApidataDocumentWithScore) GetDocumentID() *string

func (*ApidataDocumentWithScore) GetEmbedding added in v2.3.1 

func (a *ApidataDocumentWithScore) GetEmbedding() []float64

func (*ApidataDocumentWithScore) GetExtraProperties 

func (a *ApidataDocumentWithScore) GetExtraProperties() map[string]interface{}

func (*ApidataDocumentWithScore) GetIsEmbedded added in v2.3.1 

func (a *ApidataDocumentWithScore) GetIsEmbedded() *bool

func (*ApidataDocumentWithScore) GetMetadata added in v2.3.1 

func (a *ApidataDocumentWithScore) GetMetadata() map[string]interface{}

func (*ApidataDocumentWithScore) GetScore added in v2.3.1 

func (a *ApidataDocumentWithScore) GetScore() *float64

func (*ApidataDocumentWithScore) GetUUID added in v2.3.1 

func (a *ApidataDocumentWithScore) GetUUID() *string

func (*ApidataDocumentWithScore) GetUpdatedAt added in v2.3.1 

func (a *ApidataDocumentWithScore) GetUpdatedAt() *string

func (*ApidataDocumentWithScore) String 

func (a *ApidataDocumentWithScore) String() string

func (*ApidataDocumentWithScore) UnmarshalJSON 

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

type ApidataFactRatingExamples added in v2.0.1 

type ApidataFactRatingExamples struct {
	High   *string `json:"high,omitempty" url:"high,omitempty"`
	Low    *string `json:"low,omitempty" url:"low,omitempty"`
	Medium *string `json:"medium,omitempty" url:"medium,omitempty"`
	// contains filtered or unexported fields
}

func (*ApidataFactRatingExamples) GetExtraProperties added in v2.0.1 

func (a *ApidataFactRatingExamples) GetExtraProperties() map[string]interface{}

func (*ApidataFactRatingExamples) GetHigh added in v2.3.1 

func (a *ApidataFactRatingExamples) GetHigh() *string

func (*ApidataFactRatingExamples) GetLow added in v2.3.1 

func (a *ApidataFactRatingExamples) GetLow() *string

func (*ApidataFactRatingExamples) GetMedium added in v2.3.1 

func (a *ApidataFactRatingExamples) GetMedium() *string

func (*ApidataFactRatingExamples) String added in v2.0.1 

func (a *ApidataFactRatingExamples) String() string

func (*ApidataFactRatingExamples) UnmarshalJSON added in v2.0.1 

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

type BadRequestError 

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

Bad Request

func (*BadRequestError) MarshalJSON 

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

func (*BadRequestError) UnmarshalJSON 

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

func (*BadRequestError) Unwrap 

func (b *BadRequestError) Unwrap() error

type ClassifySessionRequest 

type ClassifySessionRequest struct {
	// The classes to use for classification.
	Classes []string `json:"classes,omitempty" url:"classes,omitempty"`
	// Custom instruction to use for classification.
	Instruction *string `json:"instruction,omitempty" url:"instruction,omitempty"`
	// The number of session messages to consider for classification. Defaults to 4.
	LastN *int `json:"last_n,omitempty" url:"last_n,omitempty"`
	// The name of the classifier.
	Name string `json:"name" url:"name"`
	// Deprecated
	Persist *bool `json:"persist,omitempty" url:"persist,omitempty"`
	// contains filtered or unexported fields
}

func (*ClassifySessionRequest) GetClasses added in v2.3.1 

func (c *ClassifySessionRequest) GetClasses() []string

func (*ClassifySessionRequest) GetExtraProperties 

func (c *ClassifySessionRequest) GetExtraProperties() map[string]interface{}

func (*ClassifySessionRequest) GetInstruction added in v2.3.1 

func (c *ClassifySessionRequest) GetInstruction() *string

func (*ClassifySessionRequest) GetLastN added in v2.3.1 

func (c *ClassifySessionRequest) GetLastN() *int

func (*ClassifySessionRequest) GetName added in v2.3.1 

func (c *ClassifySessionRequest) GetName() string

func (*ClassifySessionRequest) GetPersist added in v2.3.1 

func (c *ClassifySessionRequest) GetPersist() *bool

func (*ClassifySessionRequest) String 

func (c *ClassifySessionRequest) String() string

func (*ClassifySessionRequest) UnmarshalJSON 

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

type ClassifySessionResponse 

type ClassifySessionResponse = interface{}

type CommunityNode 

type CommunityNode = interface{}

type ConflictError 

type ConflictError struct {
	*core.APIError
	Body *APIError
}

Conflict

func (*ConflictError) MarshalJSON 

func (c *ConflictError) MarshalJSON() ([]byte, error)

func (*ConflictError) UnmarshalJSON 

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

func (*ConflictError) Unwrap 

func (c *ConflictError) Unwrap() error

type CreateDocumentCollectionRequest 

type CreateDocumentCollectionRequest struct {
	Description *string                `json:"description,omitempty" url:"-"`
	Metadata    map[string]interface{} `json:"metadata,omitempty" url:"-"`
}

type CreateDocumentRequest 

type CreateDocumentRequest struct {
	Content    string                 `json:"content" url:"content"`
	DocumentID *string                `json:"document_id,omitempty" url:"document_id,omitempty"`
	Metadata   map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateDocumentRequest) GetContent added in v2.3.1 

func (c *CreateDocumentRequest) GetContent() string

func (*CreateDocumentRequest) GetDocumentID added in v2.3.1 

func (c *CreateDocumentRequest) GetDocumentID() *string

func (*CreateDocumentRequest) GetExtraProperties 

func (c *CreateDocumentRequest) GetExtraProperties() map[string]interface{}

func (*CreateDocumentRequest) GetMetadata added in v2.3.1 

func (c *CreateDocumentRequest) GetMetadata() map[string]interface{}

func (*CreateDocumentRequest) String 

func (c *CreateDocumentRequest) String() string

func (*CreateDocumentRequest) UnmarshalJSON 

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

type CreateGroupRequest 

type CreateGroupRequest struct {
	Description           *string                `json:"description,omitempty" url:"-"`
	FactRatingInstruction *FactRatingInstruction `json:"fact_rating_instruction,omitempty" url:"-"`
	GroupID               string                 `json:"group_id" url:"-"`
	Name                  *string                `json:"name,omitempty" url:"-"`
}

type CreateSessionRequest 

type CreateSessionRequest struct {
	// Deprecated
	FactRatingInstruction *FactRatingInstruction `json:"fact_rating_instruction,omitempty" url:"-"`
	// Deprecated
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"-"`
	// The unique identifier of the session.
	SessionID string `json:"session_id" url:"-"`
	// The unique identifier of the user associated with the session
	UserID string `json:"user_id" url:"-"`
}

type CreateUserRequest 

type CreateUserRequest struct {
	// The email address of the user.
	Email *string `json:"email,omitempty" url:"-"`
	// Optional instruction to use for fact rating.
	FactRatingInstruction *FactRatingInstruction `json:"fact_rating_instruction,omitempty" url:"-"`
	// The first name of the user.
	FirstName *string `json:"first_name,omitempty" url:"-"`
	// The last name of the user.
	LastName *string `json:"last_name,omitempty" url:"-"`
	// The metadata associated with the user.
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"-"`
	// The unique identifier of the user.
	UserID *string `json:"user_id,omitempty" url:"-"`
}

type DocumentCollectionResponse 

type DocumentCollectionResponse = interface{}

type DocumentResponse 

type DocumentResponse = interface{}

type DocumentSearchPayload 

type DocumentSearchPayload struct {
	// Limit the number of returned documents
	Limit *int `json:"-" url:"limit,omitempty"`
	// Document metadata to filter on.
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"-"`
	MinScore *float64               `json:"min_score,omitempty" url:"-"`
	// The lambda parameter for the MMR Reranking Algorithm.
	MmrLambda *float64 `json:"mmr_lambda,omitempty" url:"-"`
	// The type of search to perform. Defaults to "similarity". Must be one of "similarity" or "mmr".
	SearchType *SearchType `json:"search_type,omitempty" url:"-"`
	// The search text.
	Text *string `json:"text,omitempty" url:"-"`
}

type DocumentSearchResult 

type DocumentSearchResult = interface{}

type DocumentSearchResultPage 

type DocumentSearchResultPage = interface{}

type EndSessionRequest 

type EndSessionRequest struct {
	Classify    *ClassifySessionRequest `json:"classify,omitempty" url:"-"`
	Instruction *string                 `json:"instruction,omitempty" url:"-"`
}

type EndSessionResponse 

type EndSessionResponse struct {
	Classification *SessionClassification `json:"classification,omitempty" url:"classification,omitempty"`
	Session        *Session               `json:"session,omitempty" url:"session,omitempty"`
	// contains filtered or unexported fields
}

func (*EndSessionResponse) GetClassification added in v2.3.1 

func (e *EndSessionResponse) GetClassification() *SessionClassification

func (*EndSessionResponse) GetExtraProperties 

func (e *EndSessionResponse) GetExtraProperties() map[string]interface{}

func (*EndSessionResponse) GetSession added in v2.3.1 

func (e *EndSessionResponse) GetSession() *Session

func (*EndSessionResponse) String 

func (e *EndSessionResponse) String() string

func (*EndSessionResponse) UnmarshalJSON 

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

type EndSessionsRequest 

type EndSessionsRequest struct {
	Instruction *string  `json:"instruction,omitempty" url:"-"`
	SessionIDs  []string `json:"session_ids,omitempty" url:"-"`
}

type EndSessionsResponse 

type EndSessionsResponse struct {
	Sessions []*Session `json:"sessions,omitempty" url:"sessions,omitempty"`
	// contains filtered or unexported fields
}

func (*EndSessionsResponse) GetExtraProperties 

func (e *EndSessionsResponse) GetExtraProperties() map[string]interface{}

func (*EndSessionsResponse) GetSessions added in v2.3.1 

func (e *EndSessionsResponse) GetSessions() []*Session

func (*EndSessionsResponse) String 

func (e *EndSessionsResponse) String() string

func (*EndSessionsResponse) UnmarshalJSON 

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

type EntityEdge 

type EntityEdge struct {
	// Creation time of the edge
	CreatedAt string `json:"created_at" url:"created_at"`
	// List of episode ids that reference these entity edges
	Episodes []string `json:"episodes,omitempty" url:"episodes,omitempty"`
	// Datetime of when the node was invalidated
	ExpiredAt *string `json:"expired_at,omitempty" url:"expired_at,omitempty"`
	// Fact representing the edge and nodes that it connects
	Fact string `json:"fact" url:"fact"`
	// Datetime of when the fact stopped being true
	InvalidAt *string `json:"invalid_at,omitempty" url:"invalid_at,omitempty"`
	// Name of the edge, relation name
	Name string `json:"name" url:"name"`
	// UUID of the source node
	SourceNodeUUID string `json:"source_node_uuid" url:"source_node_uuid"`
	// UUID of the target node
	TargetNodeUUID string `json:"target_node_uuid" url:"target_node_uuid"`
	// UUID of the edge
	UUID string `json:"uuid" url:"uuid"`
	// Datetime of when the fact became true
	ValidAt *string `json:"valid_at,omitempty" url:"valid_at,omitempty"`
	// contains filtered or unexported fields
}

func (*EntityEdge) GetCreatedAt added in v2.3.1 

func (e *EntityEdge) GetCreatedAt() string

func (*EntityEdge) GetEpisodes added in v2.3.1 

func (e *EntityEdge) GetEpisodes() []string

func (*EntityEdge) GetExpiredAt added in v2.3.1 

func (e *EntityEdge) GetExpiredAt() *string

func (*EntityEdge) GetExtraProperties 

func (e *EntityEdge) GetExtraProperties() map[string]interface{}

func (*EntityEdge) GetFact added in v2.3.1 

func (e *EntityEdge) GetFact() string

func (*EntityEdge) GetInvalidAt added in v2.3.1 

func (e *EntityEdge) GetInvalidAt() *string

func (*EntityEdge) GetName added in v2.3.1 

func (e *EntityEdge) GetName() string

func (*EntityEdge) GetSourceNodeUUID added in v2.3.1 

func (e *EntityEdge) GetSourceNodeUUID() string

func (*EntityEdge) GetTargetNodeUUID added in v2.3.1 

func (e *EntityEdge) GetTargetNodeUUID() string

func (*EntityEdge) GetUUID added in v2.3.1 

func (e *EntityEdge) GetUUID() string

func (*EntityEdge) GetValidAt added in v2.3.1 

func (e *EntityEdge) GetValidAt() *string

func (*EntityEdge) String 

func (e *EntityEdge) String() string

func (*EntityEdge) UnmarshalJSON 

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

type EntityNode 

type EntityNode struct {
	// Additional attributes of the node. Dependent on node labels
	Attributes map[string]interface{} `json:"attributes,omitempty" url:"attributes,omitempty"`
	// Creation time of the node
	CreatedAt string `json:"created_at" url:"created_at"`
	// Labels associated with the node
	Labels []string `json:"labels,omitempty" url:"labels,omitempty"`
	// Name of the node
	Name string `json:"name" url:"name"`
	// Regional summary of surrounding edges
	Summary string `json:"summary" url:"summary"`
	// UUID of the node
	UUID string `json:"uuid" url:"uuid"`
	// contains filtered or unexported fields
}

func (*EntityNode) GetAttributes added in v2.5.0 

func (e *EntityNode) GetAttributes() map[string]interface{}

func (*EntityNode) GetCreatedAt added in v2.3.1 

func (e *EntityNode) GetCreatedAt() string

func (*EntityNode) GetExtraProperties 

func (e *EntityNode) GetExtraProperties() map[string]interface{}

func (*EntityNode) GetLabels added in v2.3.1 

func (e *EntityNode) GetLabels() []string

func (*EntityNode) GetName added in v2.3.1 

func (e *EntityNode) GetName() string

func (*EntityNode) GetSummary added in v2.3.1 

func (e *EntityNode) GetSummary() string

func (*EntityNode) GetUUID added in v2.3.1 

func (e *EntityNode) GetUUID() string

func (*EntityNode) String 

func (e *EntityNode) String() string

func (*EntityNode) UnmarshalJSON 

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

type Episode 

type Episode struct {
	Content           string         `json:"content" url:"content"`
	CreatedAt         string         `json:"created_at" url:"created_at"`
	Name              *string        `json:"name,omitempty" url:"name,omitempty"`
	Source            *GraphDataType `json:"source,omitempty" url:"source,omitempty"`
	SourceDescription *string        `json:"source_description,omitempty" url:"source_description,omitempty"`
	UUID              string         `json:"uuid" url:"uuid"`
	// contains filtered or unexported fields
}

func (*Episode) GetContent added in v2.3.1 

func (e *Episode) GetContent() string

func (*Episode) GetCreatedAt added in v2.3.1 

func (e *Episode) GetCreatedAt() string

func (*Episode) GetExtraProperties 

func (e *Episode) GetExtraProperties() map[string]interface{}

func (*Episode) GetName added in v2.3.1 

func (e *Episode) GetName() *string

func (*Episode) GetSource added in v2.3.1 

func (e *Episode) GetSource() *GraphDataType

func (*Episode) GetSourceDescription added in v2.3.1 

func (e *Episode) GetSourceDescription() *string

func (*Episode) GetUUID added in v2.3.1 

func (e *Episode) GetUUID() string

func (*Episode) String 

func (e *Episode) String() string

func (*Episode) UnmarshalJSON 

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

type EpisodeResponse 

type EpisodeResponse struct {
	Episodes []*Episode `json:"episodes,omitempty" url:"episodes,omitempty"`
	// contains filtered or unexported fields
}

func (*EpisodeResponse) GetEpisodes added in v2.3.1 

func (e *EpisodeResponse) GetEpisodes() []*Episode

func (*EpisodeResponse) GetExtraProperties 

func (e *EpisodeResponse) GetExtraProperties() map[string]interface{}

func (*EpisodeResponse) String 

func (e *EpisodeResponse) String() string

func (*EpisodeResponse) UnmarshalJSON 

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

type EpisodeType 

type EpisodeType = interface{}

type ExtractDataRequest 

type ExtractDataRequest struct {
	// Your current date and time in ISO 8601 format including timezone. This is used for determining relative dates.
	CurrentDateTime *string `json:"current_date_time,omitempty" url:"-"`
	// The number of messages in the chat history from which to extract data
	LastN int `json:"last_n" url:"-"`
	// The schema describing the data to be extracted. See Zep's SDKs for more details.
	ModelSchema string `json:"model_schema" url:"-"`
	// Validate that the extracted data is present in the dialog and correct per the field description.
	// Mitigates hallucination, but is slower and may result in false negatives.
	Validate *bool `json:"validate,omitempty" url:"-"`
}

type Fact 

type Fact struct {
	Content   string  `json:"content" url:"content"`
	CreatedAt string  `json:"created_at" url:"created_at"`
	ExpiredAt *string `json:"expired_at,omitempty" url:"expired_at,omitempty"`
	// Deprecated
	Fact           string   `json:"fact" url:"fact"`
	InvalidAt      *string  `json:"invalid_at,omitempty" url:"invalid_at,omitempty"`
	Name           *string  `json:"name,omitempty" url:"name,omitempty"`
	Rating         *float64 `json:"rating,omitempty" url:"rating,omitempty"`
	SourceNodeName *string  `json:"source_node_name,omitempty" url:"source_node_name,omitempty"`
	TargetNodeName *string  `json:"target_node_name,omitempty" url:"target_node_name,omitempty"`
	UUID           string   `json:"uuid" url:"uuid"`
	ValidAt        *string  `json:"valid_at,omitempty" url:"valid_at,omitempty"`
	// contains filtered or unexported fields
}

func (*Fact) GetContent added in v2.3.1 

func (f *Fact) GetContent() string

func (*Fact) GetCreatedAt added in v2.3.1 

func (f *Fact) GetCreatedAt() string

func (*Fact) GetExpiredAt added in v2.3.1 

func (f *Fact) GetExpiredAt() *string

func (*Fact) GetExtraProperties 

func (f *Fact) GetExtraProperties() map[string]interface{}

func (*Fact) GetFact added in v2.3.1 

func (f *Fact) GetFact() string

func (*Fact) GetInvalidAt added in v2.3.1 

func (f *Fact) GetInvalidAt() *string

func (*Fact) GetName added in v2.3.1 

func (f *Fact) GetName() *string

func (*Fact) GetRating added in v2.3.1 

func (f *Fact) GetRating() *float64

func (*Fact) GetSourceNodeName added in v2.3.1 

func (f *Fact) GetSourceNodeName() *string

func (*Fact) GetTargetNodeName added in v2.3.1 

func (f *Fact) GetTargetNodeName() *string

func (*Fact) GetUUID added in v2.3.1 

func (f *Fact) GetUUID() string

func (*Fact) GetValidAt added in v2.3.1 

func (f *Fact) GetValidAt() *string

func (*Fact) String 

func (f *Fact) String() string

func (*Fact) UnmarshalJSON 

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

type FactRatingExamples 

type FactRatingExamples struct {
	High   *string `json:"high,omitempty" url:"high,omitempty"`
	Low    *string `json:"low,omitempty" url:"low,omitempty"`
	Medium *string `json:"medium,omitempty" url:"medium,omitempty"`
	// contains filtered or unexported fields
}

func (*FactRatingExamples) GetExtraProperties 

func (f *FactRatingExamples) GetExtraProperties() map[string]interface{}

func (*FactRatingExamples) GetHigh added in v2.3.1 

func (f *FactRatingExamples) GetHigh() *string

func (*FactRatingExamples) GetLow added in v2.3.1 

func (f *FactRatingExamples) GetLow() *string

func (*FactRatingExamples) GetMedium added in v2.3.1 

func (f *FactRatingExamples) GetMedium() *string

func (*FactRatingExamples) String 

func (f *FactRatingExamples) String() string

func (*FactRatingExamples) UnmarshalJSON 

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

type FactRatingInstruction 

type FactRatingInstruction struct {
	// Examples is a list of examples that demonstrate how facts might be rated based on your instruction. You should provide
	// an example of a highly rated example, a low rated example, and a medium (or in between example). For example, if you are rating
	// based on relevance to a trip planning application, your examples might be:
	// High: "Joe's dream vacation is Bali"
	// Medium: "Joe has a fear of flying",
	// Low: "Joe's favorite food is Japanese",
	Examples *FactRatingExamples `json:"examples,omitempty" url:"examples,omitempty"`
	// A string describing how to rate facts as they apply to your application. A trip planning application may
	// use something like "relevancy to planning a trip, the user's preferences when traveling,
	// or the user's travel history."
	Instruction *string `json:"instruction,omitempty" url:"instruction,omitempty"`
	// contains filtered or unexported fields
}

func (*FactRatingInstruction) GetExamples added in v2.3.1 

func (f *FactRatingInstruction) GetExamples() *FactRatingExamples

func (*FactRatingInstruction) GetExtraProperties 

func (f *FactRatingInstruction) GetExtraProperties() map[string]interface{}

func (*FactRatingInstruction) GetInstruction added in v2.3.1 

func (f *FactRatingInstruction) GetInstruction() *string

func (*FactRatingInstruction) String 

func (f *FactRatingInstruction) String() string

func (*FactRatingInstruction) UnmarshalJSON 

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

type FactResponse 

type FactResponse struct {
	Fact *Fact `json:"fact,omitempty" url:"fact,omitempty"`
	// contains filtered or unexported fields
}

func (*FactResponse) GetExtraProperties 

func (f *FactResponse) GetExtraProperties() map[string]interface{}

func (*FactResponse) GetFact added in v2.3.1 

func (f *FactResponse) GetFact() *Fact

func (*FactResponse) String 

func (f *FactResponse) String() string

func (*FactResponse) UnmarshalJSON 

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

type FactsResponse 

type FactsResponse struct {
	Facts []*Fact `json:"facts,omitempty" url:"facts,omitempty"`
	// contains filtered or unexported fields
}

func (*FactsResponse) GetExtraProperties 

func (f *FactsResponse) GetExtraProperties() map[string]interface{}

func (*FactsResponse) GetFacts added in v2.3.1 

func (f *FactsResponse) GetFacts() []*Fact

func (*FactsResponse) String 

func (f *FactsResponse) String() string

func (*FactsResponse) UnmarshalJSON 

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

type FileParam added in v2.3.1 

type FileParam struct {
	io.Reader
	// contains filtered or unexported fields
}

FileParam is a file type suitable for multipart/form-data uploads.

func NewFileParam added in v2.3.1 

func NewFileParam(
	reader io.Reader,
	filename string,
	contentType string,
	opts ...FileParamOption,
) *FileParam

NewFileParam returns a *FileParam type suitable for multipart/form-data uploads. All file upload endpoints accept a simple io.Reader, which is usually created by opening a file via os.Open.

However, some endpoints require additional metadata about the file such as a specific Content-Type or custom filename. FileParam makes it easier to create the correct type signature for these endpoints.

func (*FileParam) ContentType added in v2.3.1 

func (f *FileParam) ContentType() string

func (*FileParam) Name added in v2.3.1 

func (f *FileParam) Name() string

type FileParamOption added in v2.3.1 

type FileParamOption interface {
	// contains filtered or unexported methods
}

FileParamOption adapts the behavior of the FileParam. No options are implemented yet, but this interface allows for future extensibility.

type GetDocumentListRequest 

type GetDocumentListRequest struct {
	DocumentIDs []string `json:"document_ids,omitempty" url:"-"`
	UUIDs       []string `json:"uuids,omitempty" url:"-"`
}

type GetGroupsOrderedRequest added in v2.3.1 

type GetGroupsOrderedRequest struct {
	// Page number for pagination, starting from 1.
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// Number of groups to retrieve per page.
	PageSize *int `json:"-" url:"pageSize,omitempty"`
}

type GraphDataType 

type GraphDataType string
const (
	GraphDataTypeText    GraphDataType = "text"
	GraphDataTypeJSON    GraphDataType = "json"
	GraphDataTypeMessage GraphDataType = "message"
)

func NewGraphDataTypeFromString 

func NewGraphDataTypeFromString(s string) (GraphDataType, error)

func (GraphDataType) Ptr 

func (g GraphDataType) Ptr() *GraphDataType

type GraphSearchQuery 

type GraphSearchQuery struct {
	// Node to rerank around for node distance reranking
	CenterNodeUUID *string `json:"center_node_uuid,omitempty" url:"-"`
	// one of user_id or group_id must be provided
	GroupID *string `json:"group_id,omitempty" url:"-"`
	// The maximum number of facts to retrieve. Defaults to 10. Limited to 50.
	Limit *int `json:"limit,omitempty" url:"-"`
	// Deprecated
	MinScore *float64 `json:"min_score,omitempty" url:"-"`
	// weighting for maximal marginal relevance
	MmrLambda *float64 `json:"mmr_lambda,omitempty" url:"-"`
	// The string to search for (required)
	Query string `json:"query" url:"-"`
	// Defaults to RRF
	Reranker *Reranker `json:"reranker,omitempty" url:"-"`
	// Defaults to Edges. Communities will be added in the future.
	Scope *GraphSearchScope `json:"scope,omitempty" url:"-"`
	// Search filters to apply to the search
	SearchFilters *SearchFilters `json:"search_filters,omitempty" url:"-"`
	// one of user_id or group_id must be provided
	UserID *string `json:"user_id,omitempty" url:"-"`
}

type GraphSearchResults 

type GraphSearchResults struct {
	Edges []*EntityEdge `json:"edges,omitempty" url:"edges,omitempty"`
	Nodes []*EntityNode `json:"nodes,omitempty" url:"nodes,omitempty"`
	// contains filtered or unexported fields
}

func (*GraphSearchResults) GetEdges added in v2.3.1 

func (g *GraphSearchResults) GetEdges() []*EntityEdge

func (*GraphSearchResults) GetExtraProperties 

func (g *GraphSearchResults) GetExtraProperties() map[string]interface{}

func (*GraphSearchResults) GetNodes added in v2.3.1 

func (g *GraphSearchResults) GetNodes() []*EntityNode

func (*GraphSearchResults) String 

func (g *GraphSearchResults) String() string

func (*GraphSearchResults) UnmarshalJSON 

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

type GraphSearchScope 

type GraphSearchScope string
const (
	GraphSearchScopeEdges GraphSearchScope = "edges"
	GraphSearchScopeNodes GraphSearchScope = "nodes"
)

func NewGraphSearchScopeFromString 

func NewGraphSearchScopeFromString(s string) (GraphSearchScope, error)

func (GraphSearchScope) Ptr 

func (g GraphSearchScope) Ptr() *GraphSearchScope

type Group 

type Group struct {
	CreatedAt   *string `json:"created_at,omitempty" url:"created_at,omitempty"`
	Description *string `json:"description,omitempty" url:"description,omitempty"`
	// Deprecated
	ExternalID            *string                `json:"external_id,omitempty" url:"external_id,omitempty"`
	FactRatingInstruction *FactRatingInstruction `json:"fact_rating_instruction,omitempty" url:"fact_rating_instruction,omitempty"`
	GroupID               *string                `json:"group_id,omitempty" url:"group_id,omitempty"`
	ID                    *int                   `json:"id,omitempty" url:"id,omitempty"`
	Name                  *string                `json:"name,omitempty" url:"name,omitempty"`
	ProjectUUID           *string                `json:"project_uuid,omitempty" url:"project_uuid,omitempty"`
	UUID                  *string                `json:"uuid,omitempty" url:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*Group) GetCreatedAt added in v2.3.1 

func (g *Group) GetCreatedAt() *string

func (*Group) GetDescription added in v2.3.1 

func (g *Group) GetDescription() *string

func (*Group) GetExternalID added in v2.3.1 

func (g *Group) GetExternalID() *string

func (*Group) GetExtraProperties 

func (g *Group) GetExtraProperties() map[string]interface{}

func (*Group) GetFactRatingInstruction added in v2.3.1 

func (g *Group) GetFactRatingInstruction() *FactRatingInstruction

func (*Group) GetGroupID added in v2.3.1 

func (g *Group) GetGroupID() *string

func (*Group) GetID added in v2.3.1 

func (g *Group) GetID() *int

func (*Group) GetName added in v2.3.1 

func (g *Group) GetName() *string

func (*Group) GetProjectUUID added in v2.3.1 

func (g *Group) GetProjectUUID() *string

func (*Group) GetUUID added in v2.3.1 

func (g *Group) GetUUID() *string

func (*Group) String 

func (g *Group) String() string

func (*Group) UnmarshalJSON 

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

type GroupListResponse added in v2.3.1 

type GroupListResponse struct {
	Groups     []*Group `json:"groups,omitempty" url:"groups,omitempty"`
	RowCount   *int     `json:"row_count,omitempty" url:"row_count,omitempty"`
	TotalCount *int     `json:"total_count,omitempty" url:"total_count,omitempty"`
	// contains filtered or unexported fields
}

func (*GroupListResponse) GetExtraProperties added in v2.3.1 

func (g *GroupListResponse) GetExtraProperties() map[string]interface{}

func (*GroupListResponse) GetGroups added in v2.3.1 

func (g *GroupListResponse) GetGroups() []*Group

func (*GroupListResponse) GetRowCount added in v2.3.1 

func (g *GroupListResponse) GetRowCount() *int

func (*GroupListResponse) GetTotalCount added in v2.3.1 

func (g *GroupListResponse) GetTotalCount() *int

func (*GroupListResponse) String added in v2.3.1 

func (g *GroupListResponse) String() string

func (*GroupListResponse) UnmarshalJSON added in v2.3.1 

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

type InternalServerError 

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

Internal Server Error

func (*InternalServerError) MarshalJSON 

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

func (*InternalServerError) UnmarshalJSON 

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

func (*InternalServerError) Unwrap 

func (i *InternalServerError) Unwrap() error

type Memory 

type Memory struct {
	// Memory context containing relevant facts and entities for the session. Can be put into the prompt directly.
	Context *string `json:"context,omitempty" url:"context,omitempty"`
	// Deprecated: Use relevant_facts instead.
	Facts []string `json:"facts,omitempty" url:"facts,omitempty"`
	// A list of message objects, where each message contains a role and content. Only last_n messages will be returned
	Messages []*Message `json:"messages,omitempty" url:"messages,omitempty"`
	// Deprecated
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// Most relevant facts to the recent messages in the session.
	RelevantFacts []*Fact `json:"relevant_facts,omitempty" url:"relevant_facts,omitempty"`
	// Deprecated: Use context string instead.
	Summary *Summary `json:"summary,omitempty" url:"summary,omitempty"`
	// contains filtered or unexported fields
}

func (*Memory) GetContext added in v2.3.1 

func (m *Memory) GetContext() *string

func (*Memory) GetExtraProperties 

func (m *Memory) GetExtraProperties() map[string]interface{}

func (*Memory) GetFacts added in v2.3.1 

func (m *Memory) GetFacts() []string

func (*Memory) GetMessages added in v2.3.1 

func (m *Memory) GetMessages() []*Message

func (*Memory) GetMetadata added in v2.3.1 

func (m *Memory) GetMetadata() map[string]interface{}

func (*Memory) GetRelevantFacts added in v2.3.1 

func (m *Memory) GetRelevantFacts() []*Fact

func (*Memory) GetSummary added in v2.3.1 

func (m *Memory) GetSummary() *Summary

func (*Memory) String 

func (m *Memory) String() string

func (*Memory) UnmarshalJSON 

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

type MemoryGetRequest 

type MemoryGetRequest struct {
	// The number of most recent memory entries to retrieve.
	Lastn *int `json:"-" url:"lastn,omitempty"`
	// The minimum rating by which to filter relevant facts.
	MinRating *float64 `json:"-" url:"minRating,omitempty"`
}

type MemoryGetSessionFactsRequest 

type MemoryGetSessionFactsRequest struct {
	// Minimum rating by which to filter facts
	MinRating *float64 `json:"-" url:"minRating,omitempty"`
}

type MemoryGetSessionMessagesRequest 

type MemoryGetSessionMessagesRequest struct {
	// Limit the number of results returned
	Limit *int `json:"-" url:"limit,omitempty"`
	// Cursor for pagination
	Cursor *int `json:"-" url:"cursor,omitempty"`
}

type MemoryListSessionsRequest 

type MemoryListSessionsRequest struct {
	// Page number for pagination, starting from 1
	PageNumber *int `json:"-" url:"page_number,omitempty"`
	// Number of sessions to retrieve per page.
	PageSize *int `json:"-" url:"page_size,omitempty"`
	// Field to order the results by: created_at, updated_at, user_id, session_id.
	OrderBy *string `json:"-" url:"order_by,omitempty"`
	// Order direction: true for ascending, false for descending.
	Asc *bool `json:"-" url:"asc,omitempty"`
}

type MemorySearchPayload 

type MemorySearchPayload struct {
	// The maximum number of search results to return. Defaults to None (no limit).
	Limit *int `json:"-" url:"limit,omitempty"`
	// Metadata Filter
	Metadata      map[string]interface{} `json:"metadata,omitempty" url:"-"`
	MinFactRating *float64               `json:"min_fact_rating,omitempty" url:"-"`
	MinScore      *float64               `json:"min_score,omitempty" url:"-"`
	MmrLambda     *float64               `json:"mmr_lambda,omitempty" url:"-"`
	SearchScope   *SearchScope           `json:"search_scope,omitempty" url:"-"`
	SearchType    *SearchType            `json:"search_type,omitempty" url:"-"`
	Text          *string                `json:"text,omitempty" url:"-"`
}

type MemorySearchResult 

type MemorySearchResult struct {
	Message  *Message               `json:"message,omitempty" url:"message,omitempty"`
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	Score    *float64               `json:"score,omitempty" url:"score,omitempty"`
	Summary  *Summary               `json:"summary,omitempty" url:"summary,omitempty"`
	// contains filtered or unexported fields
}

func (*MemorySearchResult) GetExtraProperties 

func (m *MemorySearchResult) GetExtraProperties() map[string]interface{}

func (*MemorySearchResult) GetMessage added in v2.3.1 

func (m *MemorySearchResult) GetMessage() *Message

func (*MemorySearchResult) GetMetadata added in v2.3.1 

func (m *MemorySearchResult) GetMetadata() map[string]interface{}

func (*MemorySearchResult) GetScore added in v2.3.1 

func (m *MemorySearchResult) GetScore() *float64

func (*MemorySearchResult) GetSummary added in v2.3.1 

func (m *MemorySearchResult) GetSummary() *Summary

func (*MemorySearchResult) String 

func (m *MemorySearchResult) String() string

func (*MemorySearchResult) UnmarshalJSON 

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

type MemorySynthesizeQuestionRequest 

type MemorySynthesizeQuestionRequest struct {
	// The number of messages to use for question synthesis.
	LastNMessages *int `json:"-" url:"lastNMessages,omitempty"`
}

type MemoryType 

type MemoryType string
const (
	MemoryTypePerpetual        MemoryType = "perpetual"
	MemoryTypeSummaryRetriever MemoryType = "summary_retriever"
	MemoryTypeMessageWindow    MemoryType = "message_window"
)

func NewMemoryTypeFromString 

func NewMemoryTypeFromString(s string) (MemoryType, error)

func (MemoryType) Ptr 

func (m MemoryType) Ptr() *MemoryType

type Message 

type Message struct {
	// The content of the message.
	Content string `json:"content" url:"content"`
	// The timestamp of when the message was created.
	CreatedAt *string `json:"created_at,omitempty" url:"created_at,omitempty"`
	// The metadata associated with the message.
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	// Customizable role of the sender of the message (e.g., "john", "sales_agent").
	Role *string `json:"role,omitempty" url:"role,omitempty"`
	// The type of the role (e.g., "user", "system").
	RoleType RoleType `json:"role_type" url:"role_type"`
	// Deprecated
	TokenCount *int `json:"token_count,omitempty" url:"token_count,omitempty"`
	// Deprecated
	UpdatedAt *string `json:"updated_at,omitempty" url:"updated_at,omitempty"`
	// The unique identifier of the message.
	UUID *string `json:"uuid,omitempty" url:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*Message) GetContent added in v2.3.1 

func (m *Message) GetContent() string

func (*Message) GetCreatedAt added in v2.3.1 

func (m *Message) GetCreatedAt() *string

func (*Message) GetExtraProperties 

func (m *Message) GetExtraProperties() map[string]interface{}

func (*Message) GetMetadata added in v2.3.1 

func (m *Message) GetMetadata() map[string]interface{}

func (*Message) GetRole added in v2.3.1 

func (m *Message) GetRole() *string

func (*Message) GetRoleType added in v2.3.1 

func (m *Message) GetRoleType() RoleType

func (*Message) GetTokenCount added in v2.3.1 

func (m *Message) GetTokenCount() *int

func (*Message) GetUUID added in v2.3.1 

func (m *Message) GetUUID() *string

func (*Message) GetUpdatedAt added in v2.3.1 

func (m *Message) GetUpdatedAt() *string

func (*Message) String 

func (m *Message) String() string

func (*Message) UnmarshalJSON 

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

type MessageListResponse 

type MessageListResponse struct {
	// A list of message objects.
	Messages []*Message `json:"messages,omitempty" url:"messages,omitempty"`
	// The number of messages returned.
	RowCount *int `json:"row_count,omitempty" url:"row_count,omitempty"`
	// The total number of messages.
	TotalCount *int `json:"total_count,omitempty" url:"total_count,omitempty"`
	// contains filtered or unexported fields
}

func (*MessageListResponse) GetExtraProperties 

func (m *MessageListResponse) GetExtraProperties() map[string]interface{}

func (*MessageListResponse) GetMessages added in v2.3.1 

func (m *MessageListResponse) GetMessages() []*Message

func (*MessageListResponse) GetRowCount added in v2.3.1 

func (m *MessageListResponse) GetRowCount() *int

func (*MessageListResponse) GetTotalCount added in v2.3.1 

func (m *MessageListResponse) GetTotalCount() *int

func (*MessageListResponse) String 

func (m *MessageListResponse) String() string

func (*MessageListResponse) UnmarshalJSON 

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

type ModelsMessageMetadataUpdate 

type ModelsMessageMetadataUpdate struct {
	// Deprecated
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"-"`
}

type NewFact 

type NewFact struct {
	Fact *string `json:"fact,omitempty" url:"fact,omitempty"`
	// contains filtered or unexported fields
}

func (*NewFact) GetExtraProperties 

func (n *NewFact) GetExtraProperties() map[string]interface{}

func (*NewFact) GetFact added in v2.3.1 

func (n *NewFact) GetFact() *string

func (*NewFact) String 

func (n *NewFact) String() string

func (*NewFact) UnmarshalJSON 

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

type NotFoundError 

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

Not Found

func (*NotFoundError) MarshalJSON 

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

func (*NotFoundError) UnmarshalJSON 

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

func (*NotFoundError) Unwrap 

func (n *NotFoundError) Unwrap() error

type Question 

type Question struct {
	Question *string `json:"question,omitempty" url:"question,omitempty"`
	// contains filtered or unexported fields
}

func (*Question) GetExtraProperties 

func (q *Question) GetExtraProperties() map[string]interface{}

func (*Question) GetQuestion added in v2.3.1 

func (q *Question) GetQuestion() *string

func (*Question) String 

func (q *Question) String() string

func (*Question) UnmarshalJSON 

func (q *Question) UnmarshalJSON(data []byte) error

type Reranker 

type Reranker string
const (
	RerankerRrf             Reranker = "rrf"
	RerankerMmr             Reranker = "mmr"
	RerankerNodeDistance    Reranker = "node_distance"
	RerankerEpisodeMentions Reranker = "episode_mentions"
	RerankerCrossEncoder    Reranker = "cross_encoder"
)

func NewRerankerFromString 

func NewRerankerFromString(s string) (Reranker, error)

func (Reranker) Ptr 

func (r Reranker) Ptr() *Reranker

type RoleType 

type RoleType string
const (
	RoleTypeNoRole        RoleType = "norole"
	RoleTypeSystemRole    RoleType = "system"
	RoleTypeAssistantRole RoleType = "assistant"
	RoleTypeUserRole      RoleType = "user"
	RoleTypeFunctionRole  RoleType = "function"
	RoleTypeToolRole      RoleType = "tool"
)

func NewRoleTypeFromString 

func NewRoleTypeFromString(s string) (RoleType, error)

func (RoleType) Ptr 

func (r RoleType) Ptr() *RoleType

type SearchFilters added in v2.5.0 

type SearchFilters struct {
	// List of node labels to filter on
	NodeLabels []string `json:"node_labels,omitempty" url:"node_labels,omitempty"`
	// contains filtered or unexported fields
}

func (*SearchFilters) GetExtraProperties added in v2.5.0 

func (s *SearchFilters) GetExtraProperties() map[string]interface{}

func (*SearchFilters) GetNodeLabels added in v2.5.0 

func (s *SearchFilters) GetNodeLabels() []string

func (*SearchFilters) String added in v2.5.0 

func (s *SearchFilters) String() string

func (*SearchFilters) UnmarshalJSON added in v2.5.0 

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

type SearchScope 

type SearchScope string
const (
	SearchScopeMessages SearchScope = "messages"
	SearchScopeSummary  SearchScope = "summary"
	SearchScopeFacts    SearchScope = "facts"
)

func NewSearchScopeFromString 

func NewSearchScopeFromString(s string) (SearchScope, error)

func (SearchScope) Ptr 

func (s SearchScope) Ptr() *SearchScope

type SearchType 

type SearchType string
const (
	SearchTypeSimilarity SearchType = "similarity"
	SearchTypeMmr        SearchType = "mmr"
)

func NewSearchTypeFromString 

func NewSearchTypeFromString(s string) (SearchType, error)

func (SearchType) Ptr 

func (s SearchType) Ptr() *SearchType

type Session 

type Session struct {
	Classifications map[string]string `json:"classifications,omitempty" url:"classifications,omitempty"`
	CreatedAt       *string           `json:"created_at,omitempty" url:"created_at,omitempty"`
	DeletedAt       *string           `json:"deleted_at,omitempty" url:"deleted_at,omitempty"`
	EndedAt         *string           `json:"ended_at,omitempty" url:"ended_at,omitempty"`
	// Deprecated
	FactRatingInstruction *FactRatingInstruction `json:"fact_rating_instruction,omitempty" url:"fact_rating_instruction,omitempty"`
	// Deprecated
	Facts []string `json:"facts,omitempty" url:"facts,omitempty"`
	ID    *int     `json:"id,omitempty" url:"id,omitempty"`
	// Deprecated
	Metadata    map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	ProjectUUID *string                `json:"project_uuid,omitempty" url:"project_uuid,omitempty"`
	SessionID   *string                `json:"session_id,omitempty" url:"session_id,omitempty"`
	// Deprecated
	UpdatedAt *string `json:"updated_at,omitempty" url:"updated_at,omitempty"`
	UserID    *string `json:"user_id,omitempty" url:"user_id,omitempty"`
	UUID      *string `json:"uuid,omitempty" url:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*Session) GetClassifications added in v2.3.1 

func (s *Session) GetClassifications() map[string]string

func (*Session) GetCreatedAt added in v2.3.1 

func (s *Session) GetCreatedAt() *string

func (*Session) GetDeletedAt added in v2.3.1 

func (s *Session) GetDeletedAt() *string

func (*Session) GetEndedAt added in v2.3.1 

func (s *Session) GetEndedAt() *string

func (*Session) GetExtraProperties 

func (s *Session) GetExtraProperties() map[string]interface{}

func (*Session) GetFactRatingInstruction added in v2.3.1 

func (s *Session) GetFactRatingInstruction() *FactRatingInstruction

func (*Session) GetFacts added in v2.3.1 

func (s *Session) GetFacts() []string

func (*Session) GetID added in v2.3.1 

func (s *Session) GetID() *int

func (*Session) GetMetadata added in v2.3.1 

func (s *Session) GetMetadata() map[string]interface{}

func (*Session) GetProjectUUID added in v2.3.1 

func (s *Session) GetProjectUUID() *string

func (*Session) GetSessionID added in v2.3.1 

func (s *Session) GetSessionID() *string

func (*Session) GetUUID added in v2.3.1 

func (s *Session) GetUUID() *string

func (*Session) GetUpdatedAt added in v2.3.1 

func (s *Session) GetUpdatedAt() *string

func (*Session) GetUserID added in v2.3.1 

func (s *Session) GetUserID() *string

func (*Session) String 

func (s *Session) String() string

func (*Session) UnmarshalJSON 

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

type SessionClassification 

type SessionClassification struct {
	Class *string `json:"class,omitempty" url:"class,omitempty"`
	Label *string `json:"label,omitempty" url:"label,omitempty"`
	// contains filtered or unexported fields
}

func (*SessionClassification) GetClass added in v2.3.1 

func (s *SessionClassification) GetClass() *string

func (*SessionClassification) GetExtraProperties 

func (s *SessionClassification) GetExtraProperties() map[string]interface{}

func (*SessionClassification) GetLabel added in v2.3.1 

func (s *SessionClassification) GetLabel() *string

func (*SessionClassification) String 

func (s *SessionClassification) String() string

func (*SessionClassification) UnmarshalJSON 

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

type SessionFactRatingExamples 

type SessionFactRatingExamples = interface{}

type SessionFactRatingInstruction 

type SessionFactRatingInstruction = interface{}

type SessionListResponse 

type SessionListResponse struct {
	ResponseCount *int       `json:"response_count,omitempty" url:"response_count,omitempty"`
	Sessions      []*Session `json:"sessions,omitempty" url:"sessions,omitempty"`
	TotalCount    *int       `json:"total_count,omitempty" url:"total_count,omitempty"`
	// contains filtered or unexported fields
}

func (*SessionListResponse) GetExtraProperties 

func (s *SessionListResponse) GetExtraProperties() map[string]interface{}

func (*SessionListResponse) GetResponseCount added in v2.3.1 

func (s *SessionListResponse) GetResponseCount() *int

func (*SessionListResponse) GetSessions added in v2.3.1 

func (s *SessionListResponse) GetSessions() []*Session

func (*SessionListResponse) GetTotalCount added in v2.3.1 

func (s *SessionListResponse) GetTotalCount() *int

func (*SessionListResponse) String 

func (s *SessionListResponse) String() string

func (*SessionListResponse) UnmarshalJSON 

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

type SessionSearchQuery 

type SessionSearchQuery struct {
	// The maximum number of search results to return. Defaults to None (no limit).
	Limit *int `json:"-" url:"limit,omitempty"`
	// The minimum fact rating to filter on.
	MinFactRating *float64 `json:"min_fact_rating,omitempty" url:"-"`
	// The minimum score for search results.
	MinScore *float64 `json:"min_score,omitempty" url:"-"`
	// The lambda parameter for the MMR Reranking Algorithm.
	MmrLambda *float64 `json:"mmr_lambda,omitempty" url:"-"`
	// Record filter on the metadata.
	RecordFilter map[string]interface{} `json:"record_filter,omitempty" url:"-"`
	// Search scope.
	SearchScope *SearchScope `json:"search_scope,omitempty" url:"-"`
	// Search type.
	SearchType *SearchType `json:"search_type,omitempty" url:"-"`
	// the session ids to search
	SessionIDs []string `json:"session_ids,omitempty" url:"-"`
	// The search text.
	Text string `json:"text" url:"-"`
	// User ID used to determine which sessions to search.
	UserID *string `json:"user_id,omitempty" url:"-"`
}

type SessionSearchResponse 

type SessionSearchResponse struct {
	Results []*SessionSearchResult `json:"results,omitempty" url:"results,omitempty"`
	// contains filtered or unexported fields
}

func (*SessionSearchResponse) GetExtraProperties 

func (s *SessionSearchResponse) GetExtraProperties() map[string]interface{}

func (*SessionSearchResponse) GetResults added in v2.3.1 

func (s *SessionSearchResponse) GetResults() []*SessionSearchResult

func (*SessionSearchResponse) String 

func (s *SessionSearchResponse) String() string

func (*SessionSearchResponse) UnmarshalJSON 

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

type SessionSearchResult 

type SessionSearchResult struct {
	Fact      *Fact    `json:"fact,omitempty" url:"fact,omitempty"`
	Message   *Message `json:"message,omitempty" url:"message,omitempty"`
	Score     *float64 `json:"score,omitempty" url:"score,omitempty"`
	SessionID *string  `json:"session_id,omitempty" url:"session_id,omitempty"`
	Summary   *Summary `json:"summary,omitempty" url:"summary,omitempty"`
	// contains filtered or unexported fields
}

func (*SessionSearchResult) GetExtraProperties 

func (s *SessionSearchResult) GetExtraProperties() map[string]interface{}

func (*SessionSearchResult) GetFact added in v2.3.1 

func (s *SessionSearchResult) GetFact() *Fact

func (*SessionSearchResult) GetMessage added in v2.3.1 

func (s *SessionSearchResult) GetMessage() *Message

func (*SessionSearchResult) GetScore added in v2.3.1 

func (s *SessionSearchResult) GetScore() *float64

func (*SessionSearchResult) GetSessionID added in v2.3.1 

func (s *SessionSearchResult) GetSessionID() *string

func (*SessionSearchResult) GetSummary added in v2.3.1 

func (s *SessionSearchResult) GetSummary() *Summary

func (*SessionSearchResult) String 

func (s *SessionSearchResult) String() string

func (*SessionSearchResult) UnmarshalJSON 

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

type SuccessResponse 

type SuccessResponse struct {
	Message *string `json:"message,omitempty" url:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*SuccessResponse) GetExtraProperties 

func (s *SuccessResponse) GetExtraProperties() map[string]interface{}

func (*SuccessResponse) GetMessage added in v2.3.1 

func (s *SuccessResponse) GetMessage() *string

func (*SuccessResponse) String 

func (s *SuccessResponse) String() string

func (*SuccessResponse) UnmarshalJSON 

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

type Summary 

type Summary struct {
	// The content of the summary.
	Content *string `json:"content,omitempty" url:"content,omitempty"`
	// The timestamp of when the summary was created.
	CreatedAt           *string                `json:"created_at,omitempty" url:"created_at,omitempty"`
	Metadata            map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	RelatedMessageUUIDs []string               `json:"related_message_uuids,omitempty" url:"related_message_uuids,omitempty"`
	// The number of tokens in the summary.
	TokenCount *int `json:"token_count,omitempty" url:"token_count,omitempty"`
	// The unique identifier of the summary.
	UUID *string `json:"uuid,omitempty" url:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*Summary) GetContent added in v2.3.1 

func (s *Summary) GetContent() *string

func (*Summary) GetCreatedAt added in v2.3.1 

func (s *Summary) GetCreatedAt() *string

func (*Summary) GetExtraProperties 

func (s *Summary) GetExtraProperties() map[string]interface{}

func (*Summary) GetMetadata added in v2.3.1 

func (s *Summary) GetMetadata() map[string]interface{}

func (*Summary) GetRelatedMessageUUIDs added in v2.3.1 

func (s *Summary) GetRelatedMessageUUIDs() []string

func (*Summary) GetTokenCount added in v2.3.1 

func (s *Summary) GetTokenCount() *int

func (*Summary) GetUUID added in v2.3.1 

func (s *Summary) GetUUID() *string

func (*Summary) String 

func (s *Summary) String() string

func (*Summary) UnmarshalJSON 

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

type SummaryListResponse 

type SummaryListResponse struct {
	RowCount   *int       `json:"row_count,omitempty" url:"row_count,omitempty"`
	Summaries  []*Summary `json:"summaries,omitempty" url:"summaries,omitempty"`
	TotalCount *int       `json:"total_count,omitempty" url:"total_count,omitempty"`
	// contains filtered or unexported fields
}

func (*SummaryListResponse) GetExtraProperties 

func (s *SummaryListResponse) GetExtraProperties() map[string]interface{}

func (*SummaryListResponse) GetRowCount added in v2.3.1 

func (s *SummaryListResponse) GetRowCount() *int

func (*SummaryListResponse) GetSummaries added in v2.3.1 

func (s *SummaryListResponse) GetSummaries() []*Summary

func (*SummaryListResponse) GetTotalCount added in v2.3.1 

func (s *SummaryListResponse) GetTotalCount() *int

func (*SummaryListResponse) String 

func (s *SummaryListResponse) String() string

func (*SummaryListResponse) UnmarshalJSON 

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

type UnauthorizedError 

type UnauthorizedError struct {
	*core.APIError
	Body *APIError
}

Unauthorized

func (*UnauthorizedError) MarshalJSON 

func (u *UnauthorizedError) MarshalJSON() ([]byte, error)

func (*UnauthorizedError) UnmarshalJSON 

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

func (*UnauthorizedError) Unwrap 

func (u *UnauthorizedError) Unwrap() error

type UpdateDocumentCollectionRequest 

type UpdateDocumentCollectionRequest struct {
	Description *string                `json:"description,omitempty" url:"-"`
	Metadata    map[string]interface{} `json:"metadata,omitempty" url:"-"`
}

type UpdateDocumentListRequest 

type UpdateDocumentListRequest struct {
	DocumentID *string                `json:"document_id,omitempty" url:"document_id,omitempty"`
	Metadata   map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	UUID       string                 `json:"uuid" url:"uuid"`
	// contains filtered or unexported fields
}

func (*UpdateDocumentListRequest) GetDocumentID added in v2.3.1 

func (u *UpdateDocumentListRequest) GetDocumentID() *string

func (*UpdateDocumentListRequest) GetExtraProperties 

func (u *UpdateDocumentListRequest) GetExtraProperties() map[string]interface{}

func (*UpdateDocumentListRequest) GetMetadata added in v2.3.1 

func (u *UpdateDocumentListRequest) GetMetadata() map[string]interface{}

func (*UpdateDocumentListRequest) GetUUID added in v2.3.1 

func (u *UpdateDocumentListRequest) GetUUID() string

func (*UpdateDocumentListRequest) String 

func (u *UpdateDocumentListRequest) String() string

func (*UpdateDocumentListRequest) UnmarshalJSON 

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

type UpdateDocumentRequest 

type UpdateDocumentRequest struct {
	DocumentID *string                `json:"document_id,omitempty" url:"-"`
	Metadata   map[string]interface{} `json:"metadata,omitempty" url:"-"`
}

type UpdateGroupRequest 

type UpdateGroupRequest struct {
	Description           *string                `json:"description,omitempty" url:"-"`
	FactRatingInstruction *FactRatingInstruction `json:"fact_rating_instruction,omitempty" url:"-"`
	Name                  *string                `json:"name,omitempty" url:"-"`
}

type UpdateSessionRequest 

type UpdateSessionRequest struct {
	// Optional instruction to use for fact rating.
	// Fact rating instructions can not be unset.
	FactRatingInstruction *FactRatingInstruction `json:"fact_rating_instruction,omitempty" url:"-"`
	// Deprecated
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"-"`
}

type UpdateUserRequest 

type UpdateUserRequest struct {
	// The email address of the user.
	Email *string `json:"email,omitempty" url:"-"`
	// Optional instruction to use for fact rating.
	FactRatingInstruction *FactRatingInstruction `json:"fact_rating_instruction,omitempty" url:"-"`
	// The first name of the user.
	FirstName *string `json:"first_name,omitempty" url:"-"`
	// The last name of the user.
	LastName *string `json:"last_name,omitempty" url:"-"`
	// The metadata to update
	Metadata map[string]interface{} `json:"metadata,omitempty" url:"-"`
}

type User 

type User struct {
	CreatedAt             *string                `json:"created_at,omitempty" url:"created_at,omitempty"`
	DeletedAt             *string                `json:"deleted_at,omitempty" url:"deleted_at,omitempty"`
	Email                 *string                `json:"email,omitempty" url:"email,omitempty"`
	FactRatingInstruction *FactRatingInstruction `json:"fact_rating_instruction,omitempty" url:"fact_rating_instruction,omitempty"`
	FirstName             *string                `json:"first_name,omitempty" url:"first_name,omitempty"`
	ID                    *int                   `json:"id,omitempty" url:"id,omitempty"`
	LastName              *string                `json:"last_name,omitempty" url:"last_name,omitempty"`
	// Deprecated
	Metadata    map[string]interface{} `json:"metadata,omitempty" url:"metadata,omitempty"`
	ProjectUUID *string                `json:"project_uuid,omitempty" url:"project_uuid,omitempty"`
	// Deprecated
	SessionCount *int `json:"session_count,omitempty" url:"session_count,omitempty"`
	// Deprecated
	UpdatedAt *string `json:"updated_at,omitempty" url:"updated_at,omitempty"`
	UserID    *string `json:"user_id,omitempty" url:"user_id,omitempty"`
	UUID      *string `json:"uuid,omitempty" url:"uuid,omitempty"`
	// contains filtered or unexported fields
}

func (*User) GetCreatedAt added in v2.3.1 

func (u *User) GetCreatedAt() *string

func (*User) GetDeletedAt added in v2.3.1 

func (u *User) GetDeletedAt() *string

func (*User) GetEmail added in v2.3.1 

func (u *User) GetEmail() *string

func (*User) GetExtraProperties 

func (u *User) GetExtraProperties() map[string]interface{}

func (*User) GetFactRatingInstruction added in v2.3.1 

func (u *User) GetFactRatingInstruction() *FactRatingInstruction

func (*User) GetFirstName added in v2.3.1 

func (u *User) GetFirstName() *string

func (*User) GetID added in v2.3.1 

func (u *User) GetID() *int

func (*User) GetLastName added in v2.3.1 

func (u *User) GetLastName() *string

func (*User) GetMetadata added in v2.3.1 

func (u *User) GetMetadata() map[string]interface{}

func (*User) GetProjectUUID added in v2.3.1 

func (u *User) GetProjectUUID() *string

func (*User) GetSessionCount added in v2.3.1 

func (u *User) GetSessionCount() *int

func (*User) GetUUID added in v2.3.1 

func (u *User) GetUUID() *string

func (*User) GetUpdatedAt added in v2.3.1 

func (u *User) GetUpdatedAt() *string

func (*User) GetUserID added in v2.3.1 

func (u *User) GetUserID() *string

func (*User) String 

func (u *User) String() string

func (*User) UnmarshalJSON 

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

type UserListOrderedRequest 

type UserListOrderedRequest struct {
	// Page number for pagination, starting from 1
	PageNumber *int `json:"-" url:"pageNumber,omitempty"`
	// Number of users to retrieve per page
	PageSize *int `json:"-" url:"pageSize,omitempty"`
}

type UserListResponse 

type UserListResponse struct {
	RowCount   *int    `json:"row_count,omitempty" url:"row_count,omitempty"`
	TotalCount *int    `json:"total_count,omitempty" url:"total_count,omitempty"`
	Users      []*User `json:"users,omitempty" url:"users,omitempty"`
	// contains filtered or unexported fields
}

func (*UserListResponse) GetExtraProperties 

func (u *UserListResponse) GetExtraProperties() map[string]interface{}

func (*UserListResponse) GetRowCount added in v2.3.1 

func (u *UserListResponse) GetRowCount() *int

func (*UserListResponse) GetTotalCount added in v2.3.1 

func (u *UserListResponse) GetTotalCount() *int

func (*UserListResponse) GetUsers added in v2.3.1 

func (u *UserListResponse) GetUsers() []*User

func (*UserListResponse) String 

func (u *UserListResponse) String() string

func (*UserListResponse) UnmarshalJSON 

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

type UserNodeResponse added in v2.4.0 

type UserNodeResponse struct {
	Node *EntityNode `json:"node,omitempty" url:"node,omitempty"`
	// contains filtered or unexported fields
}

func (*UserNodeResponse) GetExtraProperties added in v2.4.0 

func (u *UserNodeResponse) GetExtraProperties() map[string]interface{}

func (*UserNodeResponse) GetNode added in v2.4.0 

func (u *UserNodeResponse) GetNode() *EntityNode

func (*UserNodeResponse) String added in v2.4.0 

func (u *UserNodeResponse) String() string

func (*UserNodeResponse) UnmarshalJSON added in v2.4.0 

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

Source Files

View all Source files

Directories

Path Synopsis
client
edge
episode
node

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.