opensearch
__all__ = ['OpenSearchVectorStoreDriver']
module-attribute
OpenSearchVectorStoreDriver
Bases: BaseVectorStoreDriver
A Vector Store Driver for OpenSearch.
Attributes:
Name | Type | Description |
---|---|---|
host |
str
|
The host of the OpenSearch cluster. |
port |
int
|
The port of the OpenSearch cluster. |
http_auth |
str | tuple[str, Optional[str]]
|
The HTTP authentication credentials to use. |
use_ssl |
bool
|
Whether to use SSL. |
verify_certs |
bool
|
Whether to verify SSL certificates. |
index_name |
str
|
The name of the index to use. |
Source code in griptape/drivers/vector/opensearch_vector_store_driver.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 |
|
host: str = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
http_auth: str | tuple[str, Optional[str]] = field(default=None, kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
index_name: str = field(kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
port: int = field(default=443, kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
use_ssl: bool = field(default=True, kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
verify_certs: bool = field(default=True, kw_only=True, metadata={'serializable': True})
class-attribute
instance-attribute
client()
Source code in griptape/drivers/vector/opensearch_vector_store_driver.py
delete_vector(vector_id)
load_entries(*, namespace=None)
Retrieves all vector entries from OpenSearch that match the optional namespace.
Returns:
Type | Description |
---|---|
list[Entry]
|
A list of BaseVectorStoreDriver.Entry objects. |
Source code in griptape/drivers/vector/opensearch_vector_store_driver.py
load_entry(vector_id, *, namespace=None)
Retrieves a specific vector entry from OpenSearch based on its identifier and optional namespace.
Returns:
Type | Description |
---|---|
Optional[Entry]
|
If the entry is found, it returns an instance of BaseVectorStoreDriver.Entry; otherwise, None is returned. |
Source code in griptape/drivers/vector/opensearch_vector_store_driver.py
query(query, *, count=None, namespace=None, include_vectors=False, include_metadata=True, field_name='vector', **kwargs)
Performs a nearest neighbor search on OpenSearch to find vectors similar to the provided query string.
Results can be limited using the count parameter and optionally filtered by a namespace.
Returns:
Type | Description |
---|---|
list[Entry]
|
A list of BaseVectorStoreDriver.Entry objects, each encapsulating the retrieved vector, its similarity score, metadata, and namespace. |
Source code in griptape/drivers/vector/opensearch_vector_store_driver.py
query_vector(vector, *, count=None, namespace=None, include_vectors=False, include_metadata=True, field_name='vector', **kwargs)
Performs a nearest neighbor search on OpenSearch to find vectors similar to the provided vector list.
Results can be limited using the count parameter and optionally filtered by a namespace.
Returns:
Type | Description |
---|---|
list[Entry]
|
A list of BaseVectorStoreDriver.Entry objects, each encapsulating the retrieved vector, its similarity score, metadata, and namespace. |
Source code in griptape/drivers/vector/opensearch_vector_store_driver.py
upsert_vector(vector, *, vector_id=None, namespace=None, meta=None, **kwargs)
Inserts or updates a vector in OpenSearch.
If a vector with the given vector ID already exists, it is updated; otherwise, a new vector is inserted. Metadata associated with the vector can also be provided.