integration

Documentation

Overview

Package integration provides utilities for integration with external systems, services, and frameworks.

Index

• func ToOpenAIChatCompletionMessages(messages schema.ChatMessages) ([]openai.ChatCompletionMessage, error)
• type HTTPClient
• type PartitionInput
• type PartitionOutput
• type SerpAPI
  • func NewSerpAPI(apiKey string) (*SerpAPI, error)
  • func (s *SerpAPI) Run(ctx context.Context, query string) (string, error)
• type SerpAPIOptions
• type Unstructured
  • func NewUnstructured(apiKey string, optFns ...func(o *UnstructuredOptions)) *Unstructured
  • func (c *Unstructured) Partition(ctx context.Context, input *PartitionInput) ([]PartitionOutput, error)
• type UnstructuredOptions
• type Wikipedia
  • func NewWikipedia(optFns ...func(o *WikipediaOptions)) *Wikipedia
  • func (w *Wikipedia) Run(ctx context.Context, query string) (string, error)
• type WikipediaOptions

Functions

func ToOpenAIChatCompletionMessages

func ToOpenAIChatCompletionMessages(messages schema.ChatMessages) ([]openai.ChatCompletionMessage, error)

ToOpenAIChatCompletionMessages converts a slice of schema.ChatMessage to a slice of openai.ChatCompletionMessage. It extracts the necessary information from each message to create the corresponding OpenAI chat completion message.

Types

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

type PartitionInput

type PartitionInput struct {
	File *os.File
}

PartitionInput represents the input for the Partition method.

type PartitionOutput

type PartitionOutput struct {
	Type      string `json:"type"`
	ElementID string `json:"element_id"`
	Metadata  struct {
		Filetype   string   `json:"filetype"`
		Languages  []string `json:"languages"`
		PageNumber int      `json:"page_number"`
		Filename   string   `json:"filename"`
	} `json:"metadata"`
	Text string `json:"text"`
}

PartitionOutput represents the output of the Partition method.

type SerpAPI

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

func NewSerpAPI

func NewSerpAPI(apiKey string) (*SerpAPI, error)

func (*SerpAPI) Run

func (s *SerpAPI) Run(ctx context.Context, query string) (string, error)

type SerpAPIOptions

type SerpAPIOptions struct {
	Parameter map[string]string
}

type Unstructured

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

Unstructured is a client for interacting with the Unstructured API.

func NewUnstructured

func NewUnstructured(apiKey string, optFns ...func(o *UnstructuredOptions)) *Unstructured

NewUnstructured creates a new Unstructured client with the provided API key.

func (*Unstructured) Partition

func (c *Unstructured) Partition(ctx context.Context, input *PartitionInput) ([]PartitionOutput, error)

Partition sends a file to the Unstructured API for partitioning and returns the partitioned content.

type UnstructuredOptions

type UnstructuredOptions struct {
	// BaseURL is the base URL of the Unstructured API.
	BaseURL string

	// HTTPClient is the HTTP client to use for making API requests.
	HTTPClient HTTPClient
}

UnstructuredOptions represents options for configuring the Unstructured client.

type Wikipedia

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

func NewWikipedia

func NewWikipedia(optFns ...func(o *WikipediaOptions)) *Wikipedia

func (*Wikipedia) Run

func (w *Wikipedia) Run(ctx context.Context, query string) (string, error)

type WikipediaOptions

type WikipediaOptions struct {
	LanguageCode string
	TopK         int
	DocMaxChars  int
	HTTPClient   HTTPClient
}