Module loader (0.4.0)

API documentation for loader module.

Classes

BigtableLoader

BigtableLoader(
    instance_id: str,
    table_id: str,
    row_set: typing.Optional[google.cloud.bigtable.row_set.RowSet] = None,
    filter: typing.Optional[google.cloud.bigtable.row_filters.RowFilter] = None,
    client: typing.Optional[google.cloud.bigtable.client.Client] = None,
    content_encoding: langchain_google_bigtable.loader.Encoding = Encoding.UTF8,
    content_column_family: str = "langchain",
    content_column_name: str = "content",
    metadata_mappings: typing.List[
        langchain_google_bigtable.loader.MetadataMapping
    ] = [],
    metadata_as_json_column_family: typing.Optional[str] = None,
    metadata_as_json_column_name: typing.Optional[str] = None,
    metadata_as_json_encoding: langchain_google_bigtable.loader.Encoding = Encoding.UTF8,
)

Load from the Google Cloud Platform Bigtable.

BigtableSaver

BigtableSaver(
    instance_id: str,
    table_id: str,
    client: typing.Optional[google.cloud.bigtable.client.Client] = None,
    content_encoding: langchain_google_bigtable.loader.Encoding = Encoding.UTF8,
    content_column_family: str = "langchain",
    content_column_name: str = "content",
    metadata_mappings: typing.List[
        langchain_google_bigtable.loader.MetadataMapping
    ] = [],
    metadata_as_json_column_family: typing.Optional[str] = None,
    metadata_as_json_column_name: typing.Optional[str] = None,
    metadata_as_json_encoding: langchain_google_bigtable.loader.Encoding = Encoding.UTF8,
)

Load from the Google Cloud Platform Bigtable.

MetadataMapping

MetadataMapping(column_family: 'str', column_name: 'str', metadata_key: 'str', encoding: 'Encoding', custom_encoding_func: 'Callable[[Any], bytes]' = <function MetadataMapping.__not_implemented at 0x7f3242dc2f80>, custom_decoding_func: 'Callable[[bytes], Any]' = <function MetadataMapping.__not_implemented at 0x7f3242dc2f80>)

MetadataMapping(column_family: 'str', column_name: 'str', metadata_key: 'str', encoding: 'Encoding', custom_encoding_func: 'Callable[[Any], bytes]' = <function MetadataMapping.__not_implemented at 0x7f3242dc2f80>, custom_decoding_func: 'Callable[[bytes], Any]' = <function MetadataMapping.__not_implemented at 0x7f3242dc2f80>)

Modules Functions

init_document_table

init_document_table(
    instance_id: str,
    table_id: str,
    client: typing.Optional[google.cloud.bigtable.client.Client] = None,
    content_column_family: str = "langchain",
    metadata_mappings: typing.List[
        langchain_google_bigtable.loader.MetadataMapping
    ] = [],
    metadata_as_json_column_family: typing.Optional[str] = None,
) -> None

Create a table for saving of langchain documents. If table already exists, a google.api_core.exceptions.AlreadyExists error is thrown.