# README
Swagger Docs
Swagger docs are generated through swaggo/swag from Go annotations in the Godoc comments.
Install swag
go install github.com/swaggo/swag/cmd/swag@latest
Generate docs
swag init -g api.go -o http/docs/
# Functions
ErrorCode unwraps an application error and returns its code.
Errorf is a helper function to return an Error with a given code and formatted message.
ErrorMessage unwraps an application error and returns its message.
# Constants
DefaultLimit defines default results limit.
Dim2D is 2D projection.
Dim3D is 3D projection.
API error codes.
API error codes.
API error codes.
API error codes.
API error codes.
API error codes.
No description provided by the author
PCA projection https://en.wikipedia.org/wiki/Principal_component_analysis.
No description provided by the author
TSNE projection https://en.wikipedia.org/wiki/T-distributed_stochastic_neighbor_embedding.
# Structs
Chunking splits input text into chunks if enabled.
ChunkingInput is used for chunking.
ChunkingResponse is returned when input chunking has been requested.
Embedding is vector embedding.
EmbeddingsResponse is returned when querying provider embeddings.
EmbeddingsUpdate is used to fetch embeddings.
Error represents an application-specific error.
ErrorResponse represents a JSON structure for error output.
Page is used for API paging.
ProjectionsResponse is returned when querying provider embeddings projections.
ProjectionsUpdate is used to recompute embedding projections.
Provider for embeddings.
ProviderFilter is used for filtering providers.
ProvidersResponse is returned when querying providers.
# Interfaces
ProvidersService manages embedding providers.