ollama

package

v0.4.0 Latest Latest Go to latest Published: May 18, 2024 License: Apache-2.0 Imports: 8 Imported by: 2

Details

View Source

const (
	// BaseURL is Ollama HTTP API embeddings base URL.
	BaseURL = "http://localhost:11434/api"
)

This section is empty.

func NewEmbedder(opts ...Option) embeddings.Embedder[*EmbeddingRequest]

NewEmbedder creates a client that implements embeddings.Embedder

type APIError struct {
	ErrorMessage string `json:"error"`
}

APIError is Ollama API error.

func (e APIError) Error() string

Error implements errors interface.

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

Client is an OpenAI HTTP API client.

func NewClient(opts ...Option) *Client

NewClient creates a new Ollama HTTP API client and returns it. You can override the default options via the client methods.

func (c *Client) Embed(ctx context.Context, embReq *EmbeddingRequest) ([]*embeddings.Embedding, error)

Embed returns embeddings for every object in EmbeddingRequest.

type EmbedddingResponse struct {
	Embedding []float64 `json:"embedding"`
}

EmbedddingResponse received from API.

func (e *EmbedddingResponse) ToEmbeddings() ([]*embeddings.Embedding, error)

ToEmbeddings converts the API response, into a slice of embeddings and returns it.

type EmbeddingRequest struct {
	Prompt any    `json:"prompt"`
	Model  string `json:"model"`
}

EmbeddingRequest is serialized and sent to the API server.

type Option func(*Options)

Option is functional option.

func WithBaseURL(baseURL string) Option

WithBaseURL sets the API base URL.

func WithHTTPClient(httpClient *client.HTTP) Option

WithVersion sets the API version. WithHTTPClient sets the HTTP client.

type Options struct {
	BaseURL    string
	HTTPClient *client.HTTP
}