Dynamodb
DynamoDBChatStore #
Bases: BaseChatStore
DynamoDB Chat Store.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
table_name |
str
|
The name of the preexisting DynamoDB table. |
required |
primary_key |
str
|
The primary/partition key to use for the table. Defaults to "SessionId". |
'SessionId'
|
profile_name |
str
|
The AWS profile to use. If not specified, then the default AWS profile is used. |
None
|
aws_access_key_id |
str
|
The AWS Access Key ID to use. |
None
|
aws_secret_access_key |
str
|
The AWS Secret Access Key to use. |
None
|
aws_session_token |
str
|
The AWS Session Token to use. |
None
|
botocore_session |
Any
|
Use this Botocore session instead of creating a new default one. |
None
|
botocore_config |
Any
|
Custom configuration object to use instead of the default generated one. |
None
|
region_name |
str
|
The AWS region name to use. Uses the region configured in AWS CLI if not passed. |
None
|
max_retries |
int
|
The maximum number of API retries. Defaults to 10. |
10
|
timeout |
float
|
The timeout for API requests in seconds. Defaults to 60.0. |
60.0
|
session_kwargs |
Dict[str, Any]
|
Additional kwargs for the |
None
|
resource_kwargs |
Dict[str, Any]
|
Additional kwargs for the |
None
|
Returns:
Name | Type | Description |
---|---|---|
DynamoDBChatStore |
A DynamoDB chat store object. |
Source code in llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb/llama_index/storage/chat_store/dynamodb/base.py
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 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
|
init_async_table
async
#
init_async_table()
Initialize asynchronous table.
Source code in llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb/llama_index/storage/chat_store/dynamodb/base.py
168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 |
|
set_messages #
set_messages(key: str, messages: List[ChatMessage]) -> None
Assign all provided messages to the row with the given key. Any pre-existing messages for that key will be overwritten.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key specifying a row. |
required |
messages |
List[ChatMessage]
|
The messages to assign to the key. |
required |
Returns:
Type | Description |
---|---|
None
|
None |
Source code in llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb/llama_index/storage/chat_store/dynamodb/base.py
189 190 191 192 193 194 195 196 197 198 199 200 201 202 |
|
get_messages #
get_messages(key: str) -> List[ChatMessage]
Retrieve all messages for the given key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key specifying a row. |
required |
Returns:
Type | Description |
---|---|
List[ChatMessage]
|
List[ChatMessage]: The messages associated with the key. |
Source code in llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb/llama_index/storage/chat_store/dynamodb/base.py
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
|
add_message #
add_message(key: str, message: ChatMessage) -> None
Add a message to the end of the chat history for the given key. Creates a new row if the key does not exist.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key specifying a row. |
required |
message |
ChatMessage
|
The message to add to the chat history. |
required |
Returns:
Type | Description |
---|---|
None
|
None |
Source code in llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb/llama_index/storage/chat_store/dynamodb/base.py
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
|
delete_messages #
delete_messages(key: str) -> Optional[List[ChatMessage]]
Deletes the entire chat history for the given key (i.e. the row).
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key specifying a row. |
required |
Returns:
Type | Description |
---|---|
Optional[List[ChatMessage]]
|
Optional[List[ChatMessage]]: The messages that were deleted. None if the deletion failed. |
Source code in llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb/llama_index/storage/chat_store/dynamodb/base.py
264 265 266 267 268 269 270 271 272 273 274 275 276 |
|
delete_message #
delete_message(key: str, idx: int) -> Optional[ChatMessage]
Deletes the message at the given index for the given key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key specifying a row. |
required |
idx |
int
|
The index of the message to delete. |
required |
Returns:
Type | Description |
---|---|
Optional[ChatMessage]
|
Optional[ChatMessage]: The message that was deleted. None if the index did not exist. |
Source code in llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb/llama_index/storage/chat_store/dynamodb/base.py
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
|
delete_last_message #
delete_last_message(key: str) -> Optional[ChatMessage]
Deletes the last message in the chat history for the given key.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
key |
str
|
The key specifying a row. |
required |
Returns:
Type | Description |
---|---|
Optional[ChatMessage]
|
Optional[ChatMessage]: The message that was deleted. None if the chat history was empty. |
Source code in llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb/llama_index/storage/chat_store/dynamodb/base.py
321 322 323 324 325 326 327 328 329 330 331 |
|
get_keys #
get_keys() -> List[str]
Retrieve all keys in the table.
Returns:
Type | Description |
---|---|
List[str]
|
List[str]: The keys in the table. |
Source code in llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb/llama_index/storage/chat_store/dynamodb/base.py
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 |
|