langchain_core.chat_history
.InMemoryChatMessageHistoryยถ
- class langchain_core.chat_history.InMemoryChatMessageHistory[source]ยถ
Bases:
BaseChatMessageHistory
,BaseModel
In memory implementation of chat message history.
Stores messages in an in memory list.
Create a new model by parsing and validating input data from keyword arguments.
Raises ValidationError if the input data cannot be parsed to form a valid model.
- param messages: List[BaseMessage] [Optional]ยถ
A property or attribute that returns a list of messages.
In general, getting the messages may involve IO to the underlying persistence layer, so this operation is expected to incur some latency.
- async aadd_messages(messages: Sequence[BaseMessage]) None [source]ยถ
Add messages to the store
- Parameters
messages (Sequence[BaseMessage]) โ
- Return type
None
- add_ai_message(message: Union[AIMessage, str]) None ยถ
Convenience method for adding an AI message string to the store.
Please note that this is a convenience method. Code should favor the bulk add_messages interface instead to save on round-trips to the underlying persistence layer.
This method may be deprecated in a future release.
- Parameters
message (Union[AIMessage, str]) โ The AI message to add.
- Return type
None
- add_message(message: BaseMessage) None [source]ยถ
Add a self-created message to the store
- Parameters
message (BaseMessage) โ
- Return type
None
- add_messages(messages: Sequence[BaseMessage]) None ยถ
Add a list of messages.
Implementations should over-ride this method to handle bulk addition of messages in an efficient manner to avoid unnecessary round-trips to the underlying store.
- Parameters
messages (Sequence[BaseMessage]) โ A list of BaseMessage objects to store.
- Return type
None
- add_user_message(message: Union[HumanMessage, str]) None ยถ
Convenience method for adding a human message string to the store.
Please note that this is a convenience method. Code should favor the bulk add_messages interface instead to save on round-trips to the underlying persistence layer.
This method may be deprecated in a future release.
- Parameters
message (Union[HumanMessage, str]) โ The human message to add
- Return type
None
- async aget_messages() List[BaseMessage] [source]ยถ
Async version of getting messages.
Can over-ride this method to provide an efficient async implementation.
In general, fetching messages may involve IO to the underlying persistence layer.
- Return type
List[BaseMessage]
- classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) Model ยถ
Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = โallowโ was set since it adds all passed values
- Parameters
_fields_set (Optional[SetStr]) โ
values (Any) โ
- Return type
Model
- copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) Model ยถ
Duplicate a model, optionally choose which fields to include, exclude and change.
- Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ fields to include in new model
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ fields to exclude from new model, as with values this takes precedence over include
update (Optional[DictStrAny]) โ values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data
deep (bool) โ set to True to make a deep copy of the model
self (Model) โ
- Returns
new model instance
- Return type
Model
- dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) DictStrAny ยถ
Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.
- Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ
by_alias (bool) โ
skip_defaults (Optional[bool]) โ
exclude_unset (bool) โ
exclude_defaults (bool) โ
exclude_none (bool) โ
- Return type
DictStrAny
- classmethod from_orm(obj: Any) Model ยถ
- Parameters
obj (Any) โ
- Return type
Model
- json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) unicode ยถ
Generate a JSON representation of the model, include and exclude arguments as per dict().
encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().
- Parameters
include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ
exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) โ
by_alias (bool) โ
skip_defaults (Optional[bool]) โ
exclude_unset (bool) โ
exclude_defaults (bool) โ
exclude_none (bool) โ
encoder (Optional[Callable[[Any], Any]]) โ
models_as_dict (bool) โ
dumps_kwargs (Any) โ
- Return type
unicode
- classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ยถ
- Parameters
path (Union[str, Path]) โ
content_type (unicode) โ
encoding (unicode) โ
proto (Protocol) โ
allow_pickle (bool) โ
- Return type
Model
- classmethod parse_obj(obj: Any) Model ยถ
- Parameters
obj (Any) โ
- Return type
Model
- classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) Model ยถ
- Parameters
b (Union[str, bytes]) โ
content_type (unicode) โ
encoding (unicode) โ
proto (Protocol) โ
allow_pickle (bool) โ
- Return type
Model
- classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') DictStrAny ยถ
- Parameters
by_alias (bool) โ
ref_template (unicode) โ
- Return type
DictStrAny
- classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) unicode ยถ
- Parameters
by_alias (bool) โ
ref_template (unicode) โ
dumps_kwargs (Any) โ
- Return type
unicode
- classmethod update_forward_refs(**localns: Any) None ยถ
Try to update ForwardRefs on fields based on this Model, globalns and localns.
- Parameters
localns (Any) โ
- Return type
None
- classmethod validate(value: Any) Model ยถ
- Parameters
value (Any) โ
- Return type
Model