docarray.array.storage.weaviate package

Submodules

• docarray.array.storage.weaviate.backend module
  • WeaviateConfig
    • WeaviateConfig.host
    • WeaviateConfig.port
    • WeaviateConfig.protocol
    • WeaviateConfig.name
    • WeaviateConfig.list_like
    • WeaviateConfig.serialize_config
    • WeaviateConfig.n_dim
    • WeaviateConfig.ef
    • WeaviateConfig.ef_construction
    • WeaviateConfig.timeout_config
    • WeaviateConfig.max_connections
    • WeaviateConfig.dynamic_ef_min
    • WeaviateConfig.dynamic_ef_max
    • WeaviateConfig.dynamic_ef_factor
    • WeaviateConfig.vector_cache_max_objects
    • WeaviateConfig.flat_search_cutoff
    • WeaviateConfig.cleanup_interval_seconds
    • WeaviateConfig.skip
    • WeaviateConfig.columns
    • WeaviateConfig.distance
    • WeaviateConfig.batch_size
    • WeaviateConfig.dynamic_batching
    • WeaviateConfig.root_id
  • BackendMixin
    • BackendMixin.TYPE_MAP
    • BackendMixin.name
• docarray.array.storage.weaviate.find module
  • FindMixin
• docarray.array.storage.weaviate.getsetdel module
  • GetSetDelMixin
    • GetSetDelMixin.sync()
• docarray.array.storage.weaviate.seqlike module
  • SequenceLikeMixin
    • SequenceLikeMixin.append()
    • SequenceLikeMixin.clear()
    • SequenceLikeMixin.count()
    • SequenceLikeMixin.extend()
    • SequenceLikeMixin.index()
    • SequenceLikeMixin.insert()
    • SequenceLikeMixin.pop()
    • SequenceLikeMixin.remove()
    • SequenceLikeMixin.reverse()

Module contents

class docarray.array.storage.weaviate.StorageMixins(*args, **kwds)

Bases: FindMixin, BackendMixin, GetSetDelMixin, SequenceLikeMixin, ABC

TYPE_MAP: Dict[str, TypeMap] = {'float': TypeMap(type='number', converter=<class 'float'>), 'int': TypeMap(type='int', converter=<function _safe_cast_int>), 'str': TypeMap(type='string', converter=<class 'str'>)}

append(value, **kwargs)

Append doc to the end of the array.

Parameters:

value (Document) – The doc needs to be appended.

clear()

Clear the data of DocumentArray

count(value) → integer -- return number of occurrences of value

extend(values, **kwargs)

S.extend(iterable) – extend sequence by appending elements from the iterable

Return type:

None

index(value[, start[, stop]]) → integer -- return first index of value.

Raises ValueError if the value is not present.

Supporting start and stop arguments is optional, but recommended.

insert(index, value, **kwargs)

Insert doc at index.

Parameters:

• index (int) – Position of the insertion.

• value (Document) – The doc needs to be inserted.

• kwargs – Additional Arguments that are passed to the Document Store. This has no effect for in-memory DocumentArray.

property name

An alias to _class_name that returns the id/name of the class in the weaviate of this DocumentArrayWeaviate

Returns:

name of weaviate class/schema of this DocumentArrayWeaviate

pop([index]) → item -- remove and return item at index (default last).

Raise IndexError if list is empty or index is out of range.

remove(value)

S.remove(value) – remove first occurrence of value. Raise ValueError if the value is not present.

reverse()

S.reverse() – reverse IN PLACE

sync()

class docarray.array.storage.weaviate.WeaviateConfig(host='localhost', port=8080, protocol='http', name=None, list_like=True, serialize_config=<factory>, n_dim=None, ef=None, ef_construction=None, timeout_config=(10, 60), max_connections=None, dynamic_ef_min=None, dynamic_ef_max=None, dynamic_ef_factor=None, vector_cache_max_objects=None, flat_search_cutoff=None, cleanup_interval_seconds=None, skip=None, columns=None, distance=None, batch_size=50, dynamic_batching=False, root_id=True)

Bases: object

This class stores the config variables to initialize connection to the Weaviate server

host: Optional[str] = 'localhost'

port: Optional[int] = 8080

protocol: Optional[str] = 'http'

name: Optional[str] = None

list_like: bool = True

serialize_config: Dict

n_dim: Optional[int] = None

ef: Optional[int] = None

ef_construction: Optional[int] = None

timeout_config: Optional[Tuple[int, int]] = (10, 60)

max_connections: Optional[int] = None

dynamic_ef_min: Optional[int] = None

dynamic_ef_max: Optional[int] = None

dynamic_ef_factor: Optional[int] = None

vector_cache_max_objects: Optional[int] = None

flat_search_cutoff: Optional[int] = None

cleanup_interval_seconds: Optional[int] = None

skip: Optional[bool] = None

columns: Optional[Union[List[Tuple[str, str]], Dict[str, str]]] = None

distance: Optional[str] = None

batch_size: Optional[int] = 50

dynamic_batching: Optional[bool] = False

root_id: bool = True