Safe Haskell	None
Language	Haskell2010

Pinecone.Indexes

Contents

Main types
Other types
API

Description

Indexes

Synopsis

newtype Index = Index {
- text :: Text
}
newtype Host = Host {
- text :: Text
}
data IndexModels = IndexModels {
- indexes :: Vector IndexModel
}
data IndexModel = IndexModel {
- name :: Index
- metric :: Metric
- host :: Host
- spec :: Spec
- status :: Status
- vector_type :: VectorType
- dimension :: Maybe Natural
- deletion_protection :: Maybe DeletionProtection
- tags :: Maybe (Map Text Text)
- embed :: Maybe EmbedResponse
}
data CreateIndex = CreateIndex {
- name :: Index
- spec :: Spec
- dimension :: Maybe Natural
- metric :: Maybe Metric
- deletion_protection :: Maybe DeletionProtection
- tags :: Maybe (Map Text Text)
- vector_type :: Maybe VectorType
}
_CreateIndex :: CreateIndex
data CreateIndexWithEmbedding = CreateIndexWithEmbedding {
- name :: Index
- cloud :: Cloud
- region :: Text
- embed :: EmbedRequest
- deletion_protection :: Maybe DeletionProtection
- tags :: Maybe (Map Text Text)
}
_CreateIndexWithEmbedding :: CreateIndexWithEmbedding
data ConfigureIndex = ConfigureIndex {
- spec :: Maybe Spec
- deletion_protection :: Maybe DeletionProtection
- tags :: Maybe (Map Text Text)
- embed :: Maybe EmbedRequest
}
_ConfigureIndex :: ConfigureIndex
data GetIndexStats = GetIndexStats {
- filter :: Maybe Filter
}
_GetIndexStats :: GetIndexStats
data IndexStats = IndexStats {
- namespaces :: Map Text Contents
- dimension :: Natural
- indexFullness :: Double
- totalVectorCount :: Natural
- metric :: Metric
- vectorType :: VectorType
}
data Metric
- = Cosine
- | Euclidean
- | DotProduct
data Spec = Spec {
- pod :: Maybe Pod
- serverless :: Maybe Serverless
}
data Pod = Pod {
- environment :: Text
- pod_type :: PodType
- replicas :: Maybe Natural
- shards :: Maybe Natural
- pods :: Maybe Natural
- metadata_config :: Maybe MetadataConfig
- source_collection :: Maybe Text
}
data PodType = PodType {
- prefix :: Prefix
- suffix :: Suffix
}
data Prefix
- = S1
- | P1
- | P2
data Suffix
- = X1
- | X2
- | X4
- | X8
data MetadataConfig = MetadataConfig {
- indexed :: Maybe (Vector Text)
}
data Serverless = Serverless {
- cloud :: Cloud
- region :: Text
}
data Cloud
- = GCP
- | AWS
- | Azure
data Status = Status {
- ready :: Bool
- state :: State
}
data State
- = Initializing
- | InitializationFailed
- | ScalingUp
- | ScalingDown
- | ScalingUpPodSize
- | ScalingDownPodSize
- | Terminating
- | Ready
data DeletionProtection
- = Disabled
- | Enabled
data EmbedRequest = EmbedRequest {
- model :: Text
- metric :: Maybe Metric
- read_parameters :: Maybe (Map Text Value)
- write_parameters :: Maybe (Map Text Value)
}
data EmbedResponse = EmbedResponse {
- model :: Text
- metric :: Maybe Metric
- dimension :: Maybe Natural
- vector_type :: Maybe VectorType
- field_map :: Maybe (Map Text Text)
- read_parameters :: Maybe (Map Text Value)
- write_parameters :: Maybe (Map Text Value)
}
data Contents = Contents {
- vectorCount :: Natural
}
type ControlAPI = "indexes" :> (Get '[JSON] IndexModels :<|> ((ReqBody '[JSON] CreateIndex :> Post '[JSON] IndexModel) :<|> (("create-for-model" :> (ReqBody '[JSON] CreateIndexWithEmbedding :> PostCreated '[JSON] IndexModel)) :<|> ((Capture "index_name" Index :> Get '[JSON] IndexModel) :<|> ((Capture "index_name" Index :> DeleteAccepted '[JSON] NoContent) :<|> (Capture "index_name" Index :> (ReqBody '[JSON] ConfigureIndex :> Patch '[JSON] IndexModel)))))))
type DataAPI = "describe_index_stats" :> (ReqBody '[JSON] GetIndexStats :> Post '[JSON] IndexStats)

Main types

newtype Index Source #

The name of the index

Constructors

Index
Fields text :: Text

Instances

Instances details

FromJSON Index Source #
Instance details Defined in Pinecone.Indexes Methods parseJSON :: Value -> Parser Index # parseJSONList :: Value -> Parser [Index] # omittedField :: Maybe Index #
ToJSON Index Source #
Instance details Defined in Pinecone.Indexes Methods toJSON :: Index -> Value # toEncoding :: Index -> Encoding # toJSONList :: [Index] -> Value # toEncodingList :: [Index] -> Encoding # omitField :: Index -> Bool #
IsString Index Source #
Instance details Defined in Pinecone.Indexes Methods fromString :: String -> Index #
Show Index Source #
Instance details Defined in Pinecone.Indexes Methods showsPrec :: Int -> Index -> ShowS # show :: Index -> String # showList :: [Index] -> ShowS #
Eq Index Source #
Instance details Defined in Pinecone.Indexes Methods (==) :: Index -> Index -> Bool # (/=) :: Index -> Index -> Bool #
ToHttpApiData Index Source #
Instance details Defined in Pinecone.Indexes Methods toUrlPiece :: Index -> Text # toEncodedUrlPiece :: Index -> Builder # toHeader :: Index -> ByteString # toQueryParam :: Index -> Text # toEncodedQueryParam :: Index -> Builder #

newtype Host Source #

The host for the index

Constructors

Host
Fields text :: Text

Instances

Instances details

FromJSON Host Source #
Instance details Defined in Pinecone.Indexes Methods parseJSON :: Value -> Parser Host # parseJSONList :: Value -> Parser [Host] # omittedField :: Maybe Host #
ToJSON Host Source #
Instance details Defined in Pinecone.Indexes Methods toJSON :: Host -> Value # toEncoding :: Host -> Encoding # toJSONList :: [Host] -> Value # toEncodingList :: [Host] -> Encoding # omitField :: Host -> Bool #
IsString Host Source #
Instance details Defined in Pinecone.Indexes Methods fromString :: String -> Host #
Show Host Source #
Instance details Defined in Pinecone.Indexes Methods showsPrec :: Int -> Host -> ShowS # show :: Host -> String # showList :: [Host] -> ShowS #
Eq Host Source #
Instance details Defined in Pinecone.Indexes Methods (==) :: Host -> Host -> Bool # (/=) :: Host -> Host -> Bool #
ToHttpApiData Host Source #
Instance details Defined in Pinecone.Indexes Methods toUrlPiece :: Host -> Text # toEncodedUrlPiece :: Host -> Builder # toHeader :: Host -> ByteString # toQueryParam :: Host -> Text # toEncodedQueryParam :: Host -> Builder #

data IndexModels Source #

The list of indexes that exist in the project

Constructors

IndexModels
Fields indexes :: Vector IndexModel

Instances

Instances details

FromJSON IndexModels Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser IndexModels #

parseJSONList :: Value -> Parser [IndexModels] #

omittedField :: Maybe IndexModels #

ToJSON IndexModels Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: IndexModels -> Value #

toEncoding :: IndexModels -> Encoding #

toJSONList :: [IndexModels] -> Value #

toEncodingList :: [IndexModels] -> Encoding #

omitField :: IndexModels -> Bool #

Generic IndexModels Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep IndexModels
Instance details Defined in Pinecone.Indexes type Rep IndexModels = D1 ('MetaData "IndexModels" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "IndexModels" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector IndexModel))))

Methods

from :: IndexModels -> Rep IndexModels x #

to :: Rep IndexModels x -> IndexModels #

Show IndexModels Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> IndexModels -> ShowS #

show :: IndexModels -> String #

showList :: [IndexModels] -> ShowS #

Eq IndexModels Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: IndexModels -> IndexModels -> Bool #

(/=) :: IndexModels -> IndexModels -> Bool #

type Rep IndexModels Source #

Instance details

Defined in Pinecone.Indexes

type Rep IndexModels = D1 ('MetaData "IndexModels" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "IndexModels" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Vector IndexModel))))

data IndexModel Source #

The IndexModel describes the configuration and status of a Pinecone index

Constructors

IndexModel
Fields name :: Index metric :: Metric host :: Host spec :: Spec status :: Status vector_type :: VectorType dimension :: Maybe Natural deletion_protection :: Maybe DeletionProtection tags :: Maybe (Map Text Text) embed :: Maybe EmbedResponse

Instances

Instances details

FromJSON IndexModel Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser IndexModel #

parseJSONList :: Value -> Parser [IndexModel] #

omittedField :: Maybe IndexModel #

ToJSON IndexModel Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: IndexModel -> Value #

toEncoding :: IndexModel -> Encoding #

toJSONList :: [IndexModel] -> Value #

toEncodingList :: [IndexModel] -> Encoding #

omitField :: IndexModel -> Bool #

Generic IndexModel Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep IndexModel

Instance details

Defined in Pinecone.Indexes

Methods

from :: IndexModel -> Rep IndexModel x #

to :: Rep IndexModel x -> IndexModel #

Show IndexModel Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> IndexModel -> ShowS #

show :: IndexModel -> String #

showList :: [IndexModel] -> ShowS #

Eq IndexModel Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: IndexModel -> IndexModel -> Bool #

(/=) :: IndexModel -> IndexModel -> Bool #

type Rep IndexModel Source #

Instance details

Defined in Pinecone.Indexes

data CreateIndex Source #

The desired configuration for the index

Constructors

CreateIndex
Fields name :: Index spec :: Spec dimension :: Maybe Natural metric :: Maybe Metric deletion_protection :: Maybe DeletionProtection tags :: Maybe (Map Text Text) vector_type :: Maybe VectorType

Instances

Instances details

FromJSON CreateIndex Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser CreateIndex #

parseJSONList :: Value -> Parser [CreateIndex] #

omittedField :: Maybe CreateIndex #

ToJSON CreateIndex Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: CreateIndex -> Value #

toEncoding :: CreateIndex -> Encoding #

toJSONList :: [CreateIndex] -> Value #

toEncodingList :: [CreateIndex] -> Encoding #

omitField :: CreateIndex -> Bool #

Generic CreateIndex Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep CreateIndex

Instance details

Defined in Pinecone.Indexes

type Rep CreateIndex = D1 ('MetaData "CreateIndex" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "CreateIndex" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index) :*: (S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Spec) :*: S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Metric)) :*: S1 ('MetaSel ('Just "deletion_protection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DeletionProtection))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))) :*: S1 ('MetaSel ('Just "vector_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe VectorType))))))

Methods

from :: CreateIndex -> Rep CreateIndex x #

to :: Rep CreateIndex x -> CreateIndex #

Show CreateIndex Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> CreateIndex -> ShowS #

show :: CreateIndex -> String #

showList :: [CreateIndex] -> ShowS #

Eq CreateIndex Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: CreateIndex -> CreateIndex -> Bool #

(/=) :: CreateIndex -> CreateIndex -> Bool #

type Rep CreateIndex Source #

Instance details

Defined in Pinecone.Indexes

type Rep CreateIndex = D1 ('MetaData "CreateIndex" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "CreateIndex" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index) :*: (S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Spec) :*: S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Metric)) :*: S1 ('MetaSel ('Just "deletion_protection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DeletionProtection))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))) :*: S1 ('MetaSel ('Just "vector_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe VectorType))))))

_CreateIndex :: CreateIndex Source #

Default CreateIndex

data CreateIndexWithEmbedding Source #

The desired configuration for the index and associated embedding model

Constructors

CreateIndexWithEmbedding
Fields name :: Index cloud :: Cloud region :: Text embed :: EmbedRequest deletion_protection :: Maybe DeletionProtection tags :: Maybe (Map Text Text)

Instances

Instances details

FromJSON CreateIndexWithEmbedding Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser CreateIndexWithEmbedding #

parseJSONList :: Value -> Parser [CreateIndexWithEmbedding] #

omittedField :: Maybe CreateIndexWithEmbedding #

ToJSON CreateIndexWithEmbedding Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: CreateIndexWithEmbedding -> Value #

toEncoding :: CreateIndexWithEmbedding -> Encoding #

toJSONList :: [CreateIndexWithEmbedding] -> Value #

toEncodingList :: [CreateIndexWithEmbedding] -> Encoding #

omitField :: CreateIndexWithEmbedding -> Bool #

Generic CreateIndexWithEmbedding Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep CreateIndexWithEmbedding

Instance details

Defined in Pinecone.Indexes

type Rep CreateIndexWithEmbedding = D1 ('MetaData "CreateIndexWithEmbedding" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "CreateIndexWithEmbedding" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index) :*: (S1 ('MetaSel ('Just "cloud") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cloud) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "embed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EmbedRequest) :*: (S1 ('MetaSel ('Just "deletion_protection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DeletionProtection)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))))))

Methods

from :: CreateIndexWithEmbedding -> Rep CreateIndexWithEmbedding x #

to :: Rep CreateIndexWithEmbedding x -> CreateIndexWithEmbedding #

Show CreateIndexWithEmbedding Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> CreateIndexWithEmbedding -> ShowS #

show :: CreateIndexWithEmbedding -> String #

showList :: [CreateIndexWithEmbedding] -> ShowS #

Eq CreateIndexWithEmbedding Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: CreateIndexWithEmbedding -> CreateIndexWithEmbedding -> Bool #

(/=) :: CreateIndexWithEmbedding -> CreateIndexWithEmbedding -> Bool #

type Rep CreateIndexWithEmbedding Source #

Instance details

Defined in Pinecone.Indexes

type Rep CreateIndexWithEmbedding = D1 ('MetaData "CreateIndexWithEmbedding" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "CreateIndexWithEmbedding" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Index) :*: (S1 ('MetaSel ('Just "cloud") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cloud) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :*: (S1 ('MetaSel ('Just "embed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EmbedRequest) :*: (S1 ('MetaSel ('Just "deletion_protection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DeletionProtection)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))))))

_CreateIndexWithEmbedding :: CreateIndexWithEmbedding Source #

Default CreateIndexWithEmbedding

data ConfigureIndex Source #

The desired pod size and replica configuration for the index

Constructors

ConfigureIndex
Fields spec :: Maybe Spec deletion_protection :: Maybe DeletionProtection tags :: Maybe (Map Text Text) embed :: Maybe EmbedRequest

Instances

Instances details

FromJSON ConfigureIndex Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser ConfigureIndex #

parseJSONList :: Value -> Parser [ConfigureIndex] #

omittedField :: Maybe ConfigureIndex #

ToJSON ConfigureIndex Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: ConfigureIndex -> Value #

toEncoding :: ConfigureIndex -> Encoding #

toJSONList :: [ConfigureIndex] -> Value #

toEncodingList :: [ConfigureIndex] -> Encoding #

omitField :: ConfigureIndex -> Bool #

Generic ConfigureIndex Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep ConfigureIndex

Instance details

Defined in Pinecone.Indexes

type Rep ConfigureIndex = D1 ('MetaData "ConfigureIndex" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "ConfigureIndex" 'PrefixI 'True) ((S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Spec)) :*: S1 ('MetaSel ('Just "deletion_protection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DeletionProtection))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))) :*: S1 ('MetaSel ('Just "embed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EmbedRequest)))))

Methods

from :: ConfigureIndex -> Rep ConfigureIndex x #

to :: Rep ConfigureIndex x -> ConfigureIndex #

Show ConfigureIndex Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> ConfigureIndex -> ShowS #

show :: ConfigureIndex -> String #

showList :: [ConfigureIndex] -> ShowS #

Eq ConfigureIndex Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: ConfigureIndex -> ConfigureIndex -> Bool #

(/=) :: ConfigureIndex -> ConfigureIndex -> Bool #

type Rep ConfigureIndex Source #

Instance details

Defined in Pinecone.Indexes

type Rep ConfigureIndex = D1 ('MetaData "ConfigureIndex" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "ConfigureIndex" 'PrefixI 'True) ((S1 ('MetaSel ('Just "spec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Spec)) :*: S1 ('MetaSel ('Just "deletion_protection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe DeletionProtection))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text))) :*: S1 ('MetaSel ('Just "embed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EmbedRequest)))))

_ConfigureIndex :: ConfigureIndex Source #

Default ConfigureIndex

data GetIndexStats Source #

Request body for /describe_index_stats

Constructors

GetIndexStats
Fields filter :: Maybe Filter

Instances

Instances details

FromJSON GetIndexStats Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser GetIndexStats #

parseJSONList :: Value -> Parser [GetIndexStats] #

omittedField :: Maybe GetIndexStats #

ToJSON GetIndexStats Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: GetIndexStats -> Value #

toEncoding :: GetIndexStats -> Encoding #

toJSONList :: [GetIndexStats] -> Value #

toEncodingList :: [GetIndexStats] -> Encoding #

omitField :: GetIndexStats -> Bool #

Generic GetIndexStats Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep GetIndexStats
Instance details Defined in Pinecone.Indexes type Rep GetIndexStats = D1 ('MetaData "GetIndexStats" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "GetIndexStats" 'PrefixI 'True) (S1 ('MetaSel ('Just "filter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Filter))))

Methods

from :: GetIndexStats -> Rep GetIndexStats x #

to :: Rep GetIndexStats x -> GetIndexStats #

Show GetIndexStats Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> GetIndexStats -> ShowS #

show :: GetIndexStats -> String #

showList :: [GetIndexStats] -> ShowS #

Eq GetIndexStats Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: GetIndexStats -> GetIndexStats -> Bool #

(/=) :: GetIndexStats -> GetIndexStats -> Bool #

type Rep GetIndexStats Source #

Instance details

Defined in Pinecone.Indexes

type Rep GetIndexStats = D1 ('MetaData "GetIndexStats" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "GetIndexStats" 'PrefixI 'True) (S1 ('MetaSel ('Just "filter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Filter))))

_GetIndexStats :: GetIndexStats Source #

Default GetIndexStats

data IndexStats Source #

Response body for /describe_index_stats

Constructors

IndexStats
Fields namespaces :: Map Text Contents dimension :: Natural indexFullness :: Double totalVectorCount :: Natural metric :: Metric vectorType :: VectorType

Instances

Instances details

FromJSON IndexStats Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser IndexStats #

parseJSONList :: Value -> Parser [IndexStats] #

omittedField :: Maybe IndexStats #

ToJSON IndexStats Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: IndexStats -> Value #

toEncoding :: IndexStats -> Encoding #

toJSONList :: [IndexStats] -> Value #

toEncodingList :: [IndexStats] -> Encoding #

omitField :: IndexStats -> Bool #

Generic IndexStats Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep IndexStats

Instance details

Defined in Pinecone.Indexes

type Rep IndexStats = D1 ('MetaData "IndexStats" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "IndexStats" 'PrefixI 'True) ((S1 ('MetaSel ('Just "namespaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Contents)) :*: (S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "indexFullness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :*: (S1 ('MetaSel ('Just "totalVectorCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Metric) :*: S1 ('MetaSel ('Just "vectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorType)))))

Methods

from :: IndexStats -> Rep IndexStats x #

to :: Rep IndexStats x -> IndexStats #

Show IndexStats Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> IndexStats -> ShowS #

show :: IndexStats -> String #

showList :: [IndexStats] -> ShowS #

Eq IndexStats Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: IndexStats -> IndexStats -> Bool #

(/=) :: IndexStats -> IndexStats -> Bool #

type Rep IndexStats Source #

Instance details

Defined in Pinecone.Indexes

type Rep IndexStats = D1 ('MetaData "IndexStats" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "IndexStats" 'PrefixI 'True) ((S1 ('MetaSel ('Just "namespaces") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Text Contents)) :*: (S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: S1 ('MetaSel ('Just "indexFullness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :*: (S1 ('MetaSel ('Just "totalVectorCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural) :*: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Metric) :*: S1 ('MetaSel ('Just "vectorType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 VectorType)))))

Other types

data Metric Source #

The distance metric to be used for similarity search

Constructors

Cosine
Euclidean
DotProduct

Instances

Instances details

FromJSON Metric Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser Metric #

parseJSONList :: Value -> Parser [Metric] #

omittedField :: Maybe Metric #

ToJSON Metric Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: Metric -> Value #

toEncoding :: Metric -> Encoding #

toJSONList :: [Metric] -> Value #

toEncodingList :: [Metric] -> Encoding #

omitField :: Metric -> Bool #

Generic Metric Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep Metric
Instance details Defined in Pinecone.Indexes type Rep Metric = D1 ('MetaData "Metric" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Cosine" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Euclidean" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DotProduct" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: Metric -> Rep Metric x #

to :: Rep Metric x -> Metric #

Show Metric Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> Metric -> ShowS #

show :: Metric -> String #

showList :: [Metric] -> ShowS #

Eq Metric Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: Metric -> Metric -> Bool #

(/=) :: Metric -> Metric -> Bool #

type Rep Metric Source #

Instance details

Defined in Pinecone.Indexes

type Rep Metric = D1 ('MetaData "Metric" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Cosine" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "Euclidean" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DotProduct" 'PrefixI 'False) (U1 :: Type -> Type)))

data Spec Source #

Spec object

Constructors

Spec
Fields pod :: Maybe Pod serverless :: Maybe Serverless

Instances

Instances details

FromJSON Spec Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser Spec #

parseJSONList :: Value -> Parser [Spec] #

omittedField :: Maybe Spec #

ToJSON Spec Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: Spec -> Value #

toEncoding :: Spec -> Encoding #

toJSONList :: [Spec] -> Value #

toEncodingList :: [Spec] -> Encoding #

omitField :: Spec -> Bool #

Generic Spec Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep Spec

Instance details

Defined in Pinecone.Indexes

type Rep Spec = D1 ('MetaData "Spec" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Spec" 'PrefixI 'True) (S1 ('MetaSel ('Just "pod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Pod)) :*: S1 ('MetaSel ('Just "serverless") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Serverless))))

Methods

from :: Spec -> Rep Spec x #

to :: Rep Spec x -> Spec #

Show Spec Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> Spec -> ShowS #

show :: Spec -> String #

showList :: [Spec] -> ShowS #

Eq Spec Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: Spec -> Spec -> Bool #

(/=) :: Spec -> Spec -> Bool #

type Rep Spec Source #

Instance details

Defined in Pinecone.Indexes

type Rep Spec = D1 ('MetaData "Spec" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Spec" 'PrefixI 'True) (S1 ('MetaSel ('Just "pod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Pod)) :*: S1 ('MetaSel ('Just "serverless") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Serverless))))

data Pod Source #

Configuration needed to deploy a pod-based index.

Constructors

Pod
Fields environment :: Text pod_type :: PodType replicas :: Maybe Natural shards :: Maybe Natural pods :: Maybe Natural metadata_config :: Maybe MetadataConfig source_collection :: Maybe Text

Instances

Instances details

FromJSON Pod Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser Pod #

parseJSONList :: Value -> Parser [Pod] #

omittedField :: Maybe Pod #

ToJSON Pod Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: Pod -> Value #

toEncoding :: Pod -> Encoding #

toJSONList :: [Pod] -> Value #

toEncodingList :: [Pod] -> Encoding #

omitField :: Pod -> Bool #

Generic Pod Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep Pod

Instance details

Defined in Pinecone.Indexes

type Rep Pod = D1 ('MetaData "Pod" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Pod" 'PrefixI 'True) ((S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "pod_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PodType) :*: S1 ('MetaSel ('Just "replicas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "shards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "pods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "metadata_config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MetadataConfig)) :*: S1 ('MetaSel ('Just "source_collection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

Methods

from :: Pod -> Rep Pod x #

to :: Rep Pod x -> Pod #

Show Pod Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> Pod -> ShowS #

show :: Pod -> String #

showList :: [Pod] -> ShowS #

Eq Pod Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: Pod -> Pod -> Bool #

(/=) :: Pod -> Pod -> Bool #

type Rep Pod Source #

Instance details

Defined in Pinecone.Indexes

type Rep Pod = D1 ('MetaData "Pod" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Pod" 'PrefixI 'True) ((S1 ('MetaSel ('Just "environment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "pod_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 PodType) :*: S1 ('MetaSel ('Just "replicas") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "shards") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "pods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "metadata_config") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MetadataConfig)) :*: S1 ('MetaSel ('Just "source_collection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))))

data PodType Source #

The type of pod to use

Constructors

PodType
Fields prefix :: Prefix suffix :: Suffix

Instances

Instances details

FromJSON PodType Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser PodType #

parseJSONList :: Value -> Parser [PodType] #

omittedField :: Maybe PodType #

ToJSON PodType Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: PodType -> Value #

toEncoding :: PodType -> Encoding #

toJSONList :: [PodType] -> Value #

toEncodingList :: [PodType] -> Encoding #

omitField :: PodType -> Bool #

Generic PodType Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep PodType

Instance details

Defined in Pinecone.Indexes

type Rep PodType = D1 ('MetaData "PodType" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "PodType" 'PrefixI 'True) (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Prefix) :*: S1 ('MetaSel ('Just "suffix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Suffix)))

Methods

from :: PodType -> Rep PodType x #

to :: Rep PodType x -> PodType #

Show PodType Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> PodType -> ShowS #

show :: PodType -> String #

showList :: [PodType] -> ShowS #

Eq PodType Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: PodType -> PodType -> Bool #

(/=) :: PodType -> PodType -> Bool #

type Rep PodType Source #

Instance details

Defined in Pinecone.Indexes

type Rep PodType = D1 ('MetaData "PodType" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "PodType" 'PrefixI 'True) (S1 ('MetaSel ('Just "prefix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Prefix) :*: S1 ('MetaSel ('Just "suffix") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Suffix)))

data Prefix Source #

The first component of a pod type

Constructors

S1
P1
P2

Instances

Instances details

FromJSON Prefix Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser Prefix #

parseJSONList :: Value -> Parser [Prefix] #

omittedField :: Maybe Prefix #

ToJSON Prefix Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: Prefix -> Value #

toEncoding :: Prefix -> Encoding #

toJSONList :: [Prefix] -> Value #

toEncodingList :: [Prefix] -> Encoding #

omitField :: Prefix -> Bool #

Generic Prefix Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep Prefix
Instance details Defined in Pinecone.Indexes type Rep Prefix = D1 ('MetaData "Prefix" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "S1" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "P1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "P2" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: Prefix -> Rep Prefix x #

to :: Rep Prefix x -> Prefix #

Show Prefix Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> Prefix -> ShowS #

show :: Prefix -> String #

showList :: [Prefix] -> ShowS #

Eq Prefix Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: Prefix -> Prefix -> Bool #

(/=) :: Prefix -> Prefix -> Bool #

type Rep Prefix Source #

Instance details

Defined in Pinecone.Indexes

type Rep Prefix = D1 ('MetaData "Prefix" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "S1" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "P1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "P2" 'PrefixI 'False) (U1 :: Type -> Type)))

data Suffix Source #

The second component of a pod type

Constructors

X1
X2
X4
X8

Instances

Instances details

FromJSON Suffix Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser Suffix #

parseJSONList :: Value -> Parser [Suffix] #

omittedField :: Maybe Suffix #

ToJSON Suffix Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: Suffix -> Value #

toEncoding :: Suffix -> Encoding #

toJSONList :: [Suffix] -> Value #

toEncodingList :: [Suffix] -> Encoding #

omitField :: Suffix -> Bool #

Generic Suffix Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep Suffix
Instance details Defined in Pinecone.Indexes type Rep Suffix = D1 ('MetaData "Suffix" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) ((C1 ('MetaCons "X1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "X2" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "X4" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "X8" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: Suffix -> Rep Suffix x #

to :: Rep Suffix x -> Suffix #

Show Suffix Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> Suffix -> ShowS #

show :: Suffix -> String #

showList :: [Suffix] -> ShowS #

Eq Suffix Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: Suffix -> Suffix -> Bool #

(/=) :: Suffix -> Suffix -> Bool #

type Rep Suffix Source #

Instance details

Defined in Pinecone.Indexes

type Rep Suffix = D1 ('MetaData "Suffix" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) ((C1 ('MetaCons "X1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "X2" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "X4" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "X8" 'PrefixI 'False) (U1 :: Type -> Type)))

data MetadataConfig Source #

Configuration for the behavior of Pinecone's internal metadata index

Constructors

MetadataConfig
Fields indexed :: Maybe (Vector Text)

Instances

Instances details

FromJSON MetadataConfig Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser MetadataConfig #

parseJSONList :: Value -> Parser [MetadataConfig] #

omittedField :: Maybe MetadataConfig #

ToJSON MetadataConfig Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: MetadataConfig -> Value #

toEncoding :: MetadataConfig -> Encoding #

toJSONList :: [MetadataConfig] -> Value #

toEncodingList :: [MetadataConfig] -> Encoding #

omitField :: MetadataConfig -> Bool #

Generic MetadataConfig Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep MetadataConfig
Instance details Defined in Pinecone.Indexes type Rep MetadataConfig = D1 ('MetaData "MetadataConfig" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "MetadataConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text)))))

Methods

from :: MetadataConfig -> Rep MetadataConfig x #

to :: Rep MetadataConfig x -> MetadataConfig #

Show MetadataConfig Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> MetadataConfig -> ShowS #

show :: MetadataConfig -> String #

showList :: [MetadataConfig] -> ShowS #

Eq MetadataConfig Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: MetadataConfig -> MetadataConfig -> Bool #

(/=) :: MetadataConfig -> MetadataConfig -> Bool #

type Rep MetadataConfig Source #

Instance details

Defined in Pinecone.Indexes

type Rep MetadataConfig = D1 ('MetaData "MetadataConfig" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "MetadataConfig" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Vector Text)))))

data Serverless Source #

Configuration needed to deploy a serverless index

Constructors

Serverless
Fields cloud :: Cloud region :: Text

Instances

Instances details

FromJSON Serverless Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser Serverless #

parseJSONList :: Value -> Parser [Serverless] #

omittedField :: Maybe Serverless #

ToJSON Serverless Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: Serverless -> Value #

toEncoding :: Serverless -> Encoding #

toJSONList :: [Serverless] -> Value #

toEncodingList :: [Serverless] -> Encoding #

omitField :: Serverless -> Bool #

Generic Serverless Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep Serverless

Instance details

Defined in Pinecone.Indexes

type Rep Serverless = D1 ('MetaData "Serverless" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Serverless" 'PrefixI 'True) (S1 ('MetaSel ('Just "cloud") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cloud) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Methods

from :: Serverless -> Rep Serverless x #

to :: Rep Serverless x -> Serverless #

Show Serverless Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> Serverless -> ShowS #

show :: Serverless -> String #

showList :: [Serverless] -> ShowS #

Eq Serverless Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: Serverless -> Serverless -> Bool #

(/=) :: Serverless -> Serverless -> Bool #

type Rep Serverless Source #

Instance details

Defined in Pinecone.Indexes

type Rep Serverless = D1 ('MetaData "Serverless" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Serverless" 'PrefixI 'True) (S1 ('MetaSel ('Just "cloud") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Cloud) :*: S1 ('MetaSel ('Just "region") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data Cloud Source #

The public cloud where you would like your index hosted

Constructors

GCP
AWS
Azure

Instances

Instances details

FromJSON Cloud Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser Cloud #

parseJSONList :: Value -> Parser [Cloud] #

omittedField :: Maybe Cloud #

ToJSON Cloud Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: Cloud -> Value #

toEncoding :: Cloud -> Encoding #

toJSONList :: [Cloud] -> Value #

toEncodingList :: [Cloud] -> Encoding #

omitField :: Cloud -> Bool #

Generic Cloud Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep Cloud
Instance details Defined in Pinecone.Indexes type Rep Cloud = D1 ('MetaData "Cloud" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "GCP" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AWS" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Azure" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: Cloud -> Rep Cloud x #

to :: Rep Cloud x -> Cloud #

Show Cloud Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> Cloud -> ShowS #

show :: Cloud -> String #

showList :: [Cloud] -> ShowS #

Eq Cloud Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: Cloud -> Cloud -> Bool #

(/=) :: Cloud -> Cloud -> Bool #

type Rep Cloud Source #

Instance details

Defined in Pinecone.Indexes

type Rep Cloud = D1 ('MetaData "Cloud" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "GCP" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "AWS" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Azure" 'PrefixI 'False) (U1 :: Type -> Type)))

data Status Source #

Index status

Constructors

Status
Fields ready :: Bool state :: State

Instances

Instances details

FromJSON Status Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser Status #

parseJSONList :: Value -> Parser [Status] #

omittedField :: Maybe Status #

ToJSON Status Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: Status -> Value #

toEncoding :: Status -> Encoding #

toJSONList :: [Status] -> Value #

toEncodingList :: [Status] -> Encoding #

omitField :: Status -> Bool #

Generic Status Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep Status
Instance details Defined in Pinecone.Indexes type Rep Status = D1 ('MetaData "Status" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Status" 'PrefixI 'True) (S1 ('MetaSel ('Just "ready") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 State)))

Methods

from :: Status -> Rep Status x #

to :: Rep Status x -> Status #

Show Status Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> Status -> ShowS #

show :: Status -> String #

showList :: [Status] -> ShowS #

Eq Status Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: Status -> Status -> Bool #

(/=) :: Status -> Status -> Bool #

type Rep Status Source #

Instance details

Defined in Pinecone.Indexes

type Rep Status = D1 ('MetaData "Status" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Status" 'PrefixI 'True) (S1 ('MetaSel ('Just "ready") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 State)))

data State Source #

Index state

Constructors

Initializing
InitializationFailed
ScalingUp
ScalingDown
ScalingUpPodSize
ScalingDownPodSize
Terminating
Ready

Instances

Instances details

FromJSON State Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser State #

parseJSONList :: Value -> Parser [State] #

omittedField :: Maybe State #

ToJSON State Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: State -> Value #

toEncoding :: State -> Encoding #

toJSONList :: [State] -> Value #

toEncodingList :: [State] -> Encoding #

omitField :: State -> Bool #

Generic State Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep State

Instance details

Defined in Pinecone.Indexes

type Rep State = D1 ('MetaData "State" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (((C1 ('MetaCons "Initializing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InitializationFailed" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ScalingUp" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ScalingDown" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ScalingUpPodSize" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ScalingDownPodSize" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Terminating" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ready" 'PrefixI 'False) (U1 :: Type -> Type))))

Methods

from :: State -> Rep State x #

to :: Rep State x -> State #

Show State Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> State -> ShowS #

show :: State -> String #

showList :: [State] -> ShowS #

Eq State Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: State -> State -> Bool #

(/=) :: State -> State -> Bool #

type Rep State Source #

Instance details

Defined in Pinecone.Indexes

type Rep State = D1 ('MetaData "State" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (((C1 ('MetaCons "Initializing" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "InitializationFailed" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "ScalingUp" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ScalingDown" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "ScalingUpPodSize" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ScalingDownPodSize" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Terminating" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Ready" 'PrefixI 'False) (U1 :: Type -> Type))))

data DeletionProtection Source #

Whether deletion protection is enabled/disabled for the index.

Constructors

Disabled
Enabled

Instances

Instances details

FromJSON DeletionProtection Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser DeletionProtection #

parseJSONList :: Value -> Parser [DeletionProtection] #

omittedField :: Maybe DeletionProtection #

ToJSON DeletionProtection Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: DeletionProtection -> Value #

toEncoding :: DeletionProtection -> Encoding #

toJSONList :: [DeletionProtection] -> Value #

toEncodingList :: [DeletionProtection] -> Encoding #

omitField :: DeletionProtection -> Bool #

Generic DeletionProtection Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep DeletionProtection
Instance details Defined in Pinecone.Indexes type Rep DeletionProtection = D1 ('MetaData "DeletionProtection" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Disabled" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Enabled" 'PrefixI 'False) (U1 :: Type -> Type))

Methods

from :: DeletionProtection -> Rep DeletionProtection x #

to :: Rep DeletionProtection x -> DeletionProtection #

Show DeletionProtection Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> DeletionProtection -> ShowS #

show :: DeletionProtection -> String #

showList :: [DeletionProtection] -> ShowS #

Eq DeletionProtection Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: DeletionProtection -> DeletionProtection -> Bool #

(/=) :: DeletionProtection -> DeletionProtection -> Bool #

type Rep DeletionProtection Source #

Instance details

Defined in Pinecone.Indexes

type Rep DeletionProtection = D1 ('MetaData "DeletionProtection" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Disabled" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Enabled" 'PrefixI 'False) (U1 :: Type -> Type))

data EmbedRequest Source #

Specify the integrated inference embedding configuration for the index

Constructors

EmbedRequest
Fields model :: Text metric :: Maybe Metric read_parameters :: Maybe (Map Text Value) write_parameters :: Maybe (Map Text Value)

Instances

Instances details

FromJSON EmbedRequest Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser EmbedRequest #

parseJSONList :: Value -> Parser [EmbedRequest] #

omittedField :: Maybe EmbedRequest #

ToJSON EmbedRequest Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: EmbedRequest -> Value #

toEncoding :: EmbedRequest -> Encoding #

toJSONList :: [EmbedRequest] -> Value #

toEncodingList :: [EmbedRequest] -> Encoding #

omitField :: EmbedRequest -> Bool #

Generic EmbedRequest Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep EmbedRequest

Instance details

Defined in Pinecone.Indexes

type Rep EmbedRequest = D1 ('MetaData "EmbedRequest" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "EmbedRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Metric))) :*: (S1 ('MetaSel ('Just "read_parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value))) :*: S1 ('MetaSel ('Just "write_parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value))))))

Methods

from :: EmbedRequest -> Rep EmbedRequest x #

to :: Rep EmbedRequest x -> EmbedRequest #

Show EmbedRequest Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> EmbedRequest -> ShowS #

show :: EmbedRequest -> String #

showList :: [EmbedRequest] -> ShowS #

Eq EmbedRequest Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: EmbedRequest -> EmbedRequest -> Bool #

(/=) :: EmbedRequest -> EmbedRequest -> Bool #

type Rep EmbedRequest Source #

Instance details

Defined in Pinecone.Indexes

type Rep EmbedRequest = D1 ('MetaData "EmbedRequest" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "EmbedRequest" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Metric))) :*: (S1 ('MetaSel ('Just "read_parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value))) :*: S1 ('MetaSel ('Just "write_parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value))))))

data EmbedResponse Source #

The embedding model and document fields mapped to embedding inputs

Constructors

EmbedResponse
Fields model :: Text metric :: Maybe Metric dimension :: Maybe Natural vector_type :: Maybe VectorType field_map :: Maybe (Map Text Text) read_parameters :: Maybe (Map Text Value) write_parameters :: Maybe (Map Text Value)

Instances

Instances details

FromJSON EmbedResponse Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser EmbedResponse #

parseJSONList :: Value -> Parser [EmbedResponse] #

omittedField :: Maybe EmbedResponse #

ToJSON EmbedResponse Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: EmbedResponse -> Value #

toEncoding :: EmbedResponse -> Encoding #

toJSONList :: [EmbedResponse] -> Value #

toEncodingList :: [EmbedResponse] -> Encoding #

omitField :: EmbedResponse -> Bool #

Generic EmbedResponse Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep EmbedResponse

Instance details

Defined in Pinecone.Indexes

type Rep EmbedResponse = D1 ('MetaData "EmbedResponse" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "EmbedResponse" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Metric)) :*: S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "vector_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe VectorType)) :*: S1 ('MetaSel ('Just "field_map") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))) :*: (S1 ('MetaSel ('Just "read_parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value))) :*: S1 ('MetaSel ('Just "write_parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value)))))))

Methods

from :: EmbedResponse -> Rep EmbedResponse x #

to :: Rep EmbedResponse x -> EmbedResponse #

Show EmbedResponse Source #

Instance details

Defined in Pinecone.Indexes

Methods

showsPrec :: Int -> EmbedResponse -> ShowS #

show :: EmbedResponse -> String #

showList :: [EmbedResponse] -> ShowS #

Eq EmbedResponse Source #

Instance details

Defined in Pinecone.Indexes

Methods

(==) :: EmbedResponse -> EmbedResponse -> Bool #

(/=) :: EmbedResponse -> EmbedResponse -> Bool #

type Rep EmbedResponse Source #

Instance details

Defined in Pinecone.Indexes

type Rep EmbedResponse = D1 ('MetaData "EmbedResponse" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "EmbedResponse" 'PrefixI 'True) ((S1 ('MetaSel ('Just "model") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "metric") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Metric)) :*: S1 ('MetaSel ('Just "dimension") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "vector_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe VectorType)) :*: S1 ('MetaSel ('Just "field_map") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Text)))) :*: (S1 ('MetaSel ('Just "read_parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value))) :*: S1 ('MetaSel ('Just "write_parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text Value)))))))

data Contents Source #

A summary of the contents of a namespace

Constructors

Contents
Fields vectorCount :: Natural

Instances

Instances details

FromJSON Contents Source #

Instance details

Defined in Pinecone.Indexes

Methods

parseJSON :: Value -> Parser Contents #

parseJSONList :: Value -> Parser [Contents] #

omittedField :: Maybe Contents #

ToJSON Contents Source #

Instance details

Defined in Pinecone.Indexes

Methods

toJSON :: Contents -> Value #

toEncoding :: Contents -> Encoding #

toJSONList :: [Contents] -> Value #

toEncodingList :: [Contents] -> Encoding #

omitField :: Contents -> Bool #

Generic Contents Source #

Instance details

Defined in Pinecone.Indexes

Associated Types

type Rep Contents
Instance details Defined in Pinecone.Indexes type Rep Contents = D1 ('MetaData "Contents" "Pinecone.Indexes" "pinecone-1.0.0-FtIUEL1n6VI5sRXEYSiB7n" 'False) (C1 ('MetaCons "Contents" 'PrefixI 'True) (S1 ('MetaSel ('Just "vectorCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Natural)))