Pinecone.Vector (pinecone v0.1.0)

Link to this section Summary

Link to this section Types

Link to this type

delete_params()

@type delete_params() :: %{
  :ids => [String.t()],
  optional(:namespace) => String.t(),
  optional(:deleteAll) => boolean()
}
Link to this type

query_params()

@type query_params() :: %{
  :topK => integer(),
  optional(:namespace) => String.t(),
  optional(:filter) => map(),
  optional(:includeValues) => boolean(),
  optional(:includeMetadata) => boolean(),
  optional(:vector) => [float()],
  optional(:id) => String.t()
}
Link to this type

upsert_params()

@type upsert_params() :: %{:vectors => [vector()], optional(:namespace) => String.t()}
@type vector() :: %{
  :values => [float()],
  :id => String.t(),
  optional(:metadata) => map()
}

Link to this section Functions

Link to this function

delete(client, params, opts \\ [])

@spec delete(Pinecone.Client.t(), delete_params(), Keyword.t()) ::
  {:ok, term()} | {:error, term()}
Link to this function

query(client, params, opts \\ [])

@spec query(Pinecone.Client.t(), query_params(), Keyword.t()) ::
  {:ok, term()} | {:error, term()}
Link to this function

upsert(client, params, opts \\ [])

@spec upsert(Pinecone.Client.t(), upsert_params(), Keyword.t()) ::
  {:ok, term()} | {:error, term()}