Collection

Collection(**kwargs)

A Collection object for PGVector.
Attributes:
client: The PGVector client.
collection_name (str): The name of the collection. Default is “documents”.
embedding_function (Callable): The embedding function used to generate the vector representation.
Default is None. SentenceTransformer(“all-MiniLM-L6-v2”).encode will be used when None.
Models can be chosen from:
https://huggingface.co/models?library=sentence-transformers metadata (Optional[dict[str, Any]]): The metadata of the collection.
get_or_create (Optional): The flag indicating whether to get or create the collection.
Initialize the Collection object.

Parameters:
NameDescription
**kwargs

Instance Methods

add

add(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

convert_string_to_array

convert_string_to_array(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

cosine_distance

cosine_distance(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

count

count(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

create_collection

create_collection(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

delete

delete(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

delete_collection

delete_collection(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

euclidean_distance

euclidean_distance(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

get

get(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

inner_product_distance

inner_product_distance(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

modify

modify(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

query

query(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

set_collection_name

set_collection_name(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

table_exists

table_exists(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

update

update(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs

upsert

upsert(*args, **kwargs) -> 

Call self as a function.

Parameters:
NameDescription
*args
**kwargs