openai-2.2.1: Servant bindings to OpenAI

Safe Haskell	None
Language	Haskell2010

OpenAI.V1.Embeddings

Contents

Main types
Other types
Servant

Description

/v1/embeddings

Synopsis

data CreateEmbeddings = CreateEmbeddings {
- input :: Text
- model :: Model
- encoding_format :: Maybe EncodingFormat
- dimensions :: Maybe Natural
- user :: Maybe Text
}
_CreateEmbeddings :: CreateEmbeddings
data EmbeddingObject = EmbbeddingObject {
- index :: Natural
- embedding :: Vector Double
- object :: Text
}
data EncodingFormat
- = Float
- | Base64
type API = "embeddings" :> (ReqBody '[JSON] CreateEmbeddings :> Post '[JSON] (ListOf EmbeddingObject))

Main types

data CreateEmbeddings Source #

Request body for /v1/embeddings

Constructors

CreateEmbeddings
Fields input :: Text model :: Model encoding_format :: Maybe EncodingFormat dimensions :: Maybe Natural user :: Maybe Text

Instances

Instances details

FromJSON CreateEmbeddings Source #

Instance details

Defined in OpenAI.V1.Embeddings

Methods

parseJSON :: Value -> Parser CreateEmbeddings #

parseJSONList :: Value -> Parser [CreateEmbeddings] #

omittedField :: Maybe CreateEmbeddings #

ToJSON CreateEmbeddings Source #

Instance details

Defined in OpenAI.V1.Embeddings

Methods

toJSON :: CreateEmbeddings -> Value #

toEncoding :: CreateEmbeddings -> Encoding #

toJSONList :: [CreateEmbeddings] -> Value #

toEncodingList :: [CreateEmbeddings] -> Encoding #

omitField :: CreateEmbeddings -> Bool #

Generic CreateEmbeddings Source #

Instance details

Defined in OpenAI.V1.Embeddings

Associated Types

type Rep CreateEmbeddings

Instance details

Defined in OpenAI.V1.Embeddings

type Rep CreateEmbeddings = D1 ('MetaData "CreateEmbeddings" "OpenAI.V1.Embeddings" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CreateEmbeddings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model)) :*: (S1 ('MetaSel ('Just "encoding_format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EncodingFormat)) :*: (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

Methods

from :: CreateEmbeddings -> Rep CreateEmbeddings x #

to :: Rep CreateEmbeddings x -> CreateEmbeddings #

Show CreateEmbeddings Source #

Instance details

Defined in OpenAI.V1.Embeddings

Methods

showsPrec :: Int -> CreateEmbeddings -> ShowS #

show :: CreateEmbeddings -> String #

showList :: [CreateEmbeddings] -> ShowS #

type Rep CreateEmbeddings Source #

Instance details

Defined in OpenAI.V1.Embeddings

type Rep CreateEmbeddings = D1 ('MetaData "CreateEmbeddings" "OpenAI.V1.Embeddings" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "CreateEmbeddings" 'PrefixI 'True) ((S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Model)) :*: (S1 ('MetaSel ('Just "encoding_format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EncodingFormat)) :*: (S1 ('MetaSel ('Just "dimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

_CreateEmbeddings :: CreateEmbeddings Source #

Default CreateEmbeddings

data EmbeddingObject Source #

The embedding object

Constructors

EmbbeddingObject
Fields index :: Natural embedding :: Vector Double object :: Text

Instances

Instances details

FromJSON EmbeddingObject Source #

Instance details

Defined in OpenAI.V1.Embeddings

Methods

parseJSON :: Value -> Parser EmbeddingObject #

parseJSONList :: Value -> Parser [EmbeddingObject] #

omittedField :: Maybe EmbeddingObject #

ToJSON EmbeddingObject Source #

Instance details

Defined in OpenAI.V1.Embeddings

Methods

toJSON :: EmbeddingObject -> Value #

toEncoding :: EmbeddingObject -> Encoding #

toJSONList :: [EmbeddingObject] -> Value #

toEncodingList :: [EmbeddingObject] -> Encoding #

omitField :: EmbeddingObject -> Bool #

Generic EmbeddingObject Source #

Instance details

Defined in OpenAI.V1.Embeddings

Associated Types

type Rep EmbeddingObject

Instance details

Defined in OpenAI.V1.Embeddings

type Rep EmbeddingObject = D1 ('MetaData "EmbeddingObject" "OpenAI.V1.Embeddings" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "EmbbeddingObject" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "embedding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Double)) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Methods

from :: EmbeddingObject -> Rep EmbeddingObject x #

to :: Rep EmbeddingObject x -> EmbeddingObject #

Show EmbeddingObject Source #

Instance details

Defined in OpenAI.V1.Embeddings

Methods

showsPrec :: Int -> EmbeddingObject -> ShowS #

show :: EmbeddingObject -> String #

showList :: [EmbeddingObject] -> ShowS #

type Rep EmbeddingObject Source #

Instance details

Defined in OpenAI.V1.Embeddings

type Rep EmbeddingObject = D1 ('MetaData "EmbeddingObject" "OpenAI.V1.Embeddings" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "EmbbeddingObject" 'PrefixI 'True) (S1 ('MetaSel ('Just "index") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "embedding") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector Double)) :*: S1 ('MetaSel ('Just "object") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

Other types

data EncodingFormat Source #

The format to return the embeddings in

Constructors

Float
Base64

Instances

Instances details

FromJSON EncodingFormat Source #

Instance details

Defined in OpenAI.V1.Embeddings

Methods

parseJSON :: Value -> Parser EncodingFormat #

parseJSONList :: Value -> Parser [EncodingFormat] #

omittedField :: Maybe EncodingFormat #

ToJSON EncodingFormat Source #

Instance details

Defined in OpenAI.V1.Embeddings

Methods

toJSON :: EncodingFormat -> Value #

toEncoding :: EncodingFormat -> Encoding #

toJSONList :: [EncodingFormat] -> Value #

toEncodingList :: [EncodingFormat] -> Encoding #

omitField :: EncodingFormat -> Bool #

Generic EncodingFormat Source #

Instance details

Defined in OpenAI.V1.Embeddings

Associated Types

type Rep EncodingFormat
Instance details Defined in OpenAI.V1.Embeddings type Rep EncodingFormat = D1 ('MetaData "EncodingFormat" "OpenAI.V1.Embeddings" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Float" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Base64" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: EncodingFormat -> Rep EncodingFormat x #

to :: Rep EncodingFormat x -> EncodingFormat #

Show EncodingFormat Source #

Instance details

Defined in OpenAI.V1.Embeddings

Methods

showsPrec :: Int -> EncodingFormat -> ShowS #

show :: EncodingFormat -> String #

showList :: [EncodingFormat] -> ShowS #

type Rep EncodingFormat Source #

Instance details

Defined in OpenAI.V1.Embeddings

type Rep EncodingFormat = D1 ('MetaData "EncodingFormat" "OpenAI.V1.Embeddings" "openai-2.2.1-FjXYHvgDuLi5dBzIG7AGPx" 'False) (C1 ('MetaCons "Float" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Base64" 'PrefixI 'False) (U1 :: Type -> Type))

Servant

type API = "embeddings" :> (ReqBody '[JSON] CreateEmbeddings :> Post '[JSON] (ListOf EmbeddingObject)) Source #

Servant API