libs.teradata.langchain_teradata.TeradataVectorStore.add_embeddings = add_embeddings(self, data, **kwargs)

DESCRIPTION:
    Adds data to an existing embedding-based vector store.
    Creates a new Vector Store in case it does not exists.
 
PARAMETERS:
    data:
        Required Argument.
        Specifies the table name(s)/teradataml DataFrame(s) that are pre embedded to be
        indexed or to be added to the vector store.
        Teradata recommends to use teradataml DataFrame as input.
        Notes:
            * If multiple tables/views are passed, each table should
              have the columns which are mentioned in "data_columns"
              and "key_columns".
            * When "target_database" is not set, and only table name is passed to
              "data", then the input is searched in default database.
        Types: str, DataFrame, or list of str/DataFrame
 
    name:
        Optional Argument.
        Specifies the name of the vector store to be created from
        input data.
        Types: str
 
    data_columns:
        Optional Argument.
        Specifies the name of the column that contains the
        pre embedded data.
        Note:
            When multiple data columns are specified, data is unpivoted
            to get a new key column "AttributeName" and a single data column
            "AttributeValue".
        Types: str, list of str
 
    is_normalized:
        Optional Argument.
        Specifies whether the input contains normalized embeddings.
        Default Value: False
        Types: bool
 
    key_columns:
        Optional Argument.
        Specifies the name(s) of the key column(s) to be used for indexing.
        Types: str, list of str
 
    update_style:
        Optional Argument.
        Specifies the style to be used for alter operation of the data
        from the vector store when "search_algorithm" is KMEANS/HNSW.
        Default Value: MINOR
        Permitted Values: MINOR, MAJOR
        Types: str
 
    metadata_operation:
        Optional Argument.
        Specifies the operation to be performed on metadata columns
        during update.
        - ADD -  add new metadata columns
        - DELETE - remove existing metadata columns
        - MODIFY - change the description of the existing metadata columns
 
        Note:
            * Applicable to all store types except the METADATA-BASED store type.
        Default Value: ADD
        Permitted Values: ADD, DELETE, MODIFY
        Types: str
 
    description:
        Optional Argument.
        Specifies the description of the vector store.
        Types: str
 
    target_database:
        Optional Argument.
        Specifies the database name where the vector store is created.
        Notes:
            * If not specified, vector store is created in the database
              which is in use.
        Types: str
 
    vector_column:
        Optional Argument.
        Specifies the name of the column to be used for storing
        the embeddings.
        Default Value: vector_index
        Types: str
 
    metadata_columns:
        Optional Argument.
        Specifies the list of input column names to be used for metadata.
        These columns just get accumulated in the vector store.
        Types: list[str]
 
    metadata_descriptions:
        Optional Argument.
        Specifies the deescriptions of the metadata columns. One value for each metadata column.
        Note:
            Applicable to all store types except metadata-based store type.
        Types: list[str]
 
    use_simd:
        Optional Argument.
        Specifies whether to use SIMD for faster processing.
        Types: bool
 
    embedding_datatype:
        Optional Argument.
        Specifies the data type of the embeddings to be used.
        Default Value: VECTOR32
        Permitted Values: VECTOR32, VECTOR64
        Types: str
 
    embedding:
        Required for NVIDIA NIM, Optional otherwise.
        Specifies the embeddings model to be used for generating the
        embeddings.
        Default Value:
            For AWS: amazon.titan-embed-text-v2:0
            For Azure: text-embedding-3-small
        Permitted Values:
            For AWS:
                * amazon.titan-embed-text-v1
                * amazon.titan-embed-image-v1
                * amazon.titan-embed-text-v2:0
            For Azure:
                * text-embedding-ada-002
                * text-embedding-3-small
                * text-embedding-3-large
            For NIM:
                * Any hosted NVIDIA model for embedding generation
        Types: str, TeradataAI
 
    embeddings_dims:
        Required for NVIDIA NIM, Optional otherwise.
        Specifies the number of dimensions to be used for generating the embeddings.
        The value depends on the "embeddings".
        Note:
            * Default dimesions is set to 1024 for embedding-based vector store.
        Default Value:
            For AWS:
                * amazon.titan-embed-text-v1: 1536
                * amazon.titan-embed-image-v1: 1024
                * amazon.titan-embed-text-v2:0: 1024
            For Azure:
                * text-embedding-ada-002: 1536
                * text-embedding-3-small: 1536
                * text-embedding-3-large: 3072
        Permitted Values:
            *For AWS:
                * amazon.titan-embed-text-v1: 1536
                * amazon.titan-embed-image-v1: [256, 384, 1024]
                * amazon.titan-embed-text-v2:0: [256, 512, 1024]
            *For Azure:
                * text-embedding-ada-002: 1536 only
                * text-embedding-3-small: 1 <= dims <= 1536
                * text-embedding-3-large: 1 <= dims <= 3072
        Types: str
 
    chat_completion_model:
        Required for NVIDIA NIM, Optional otherwise.
        Specifies the name of the chat completion model to be used for
        generating text responses.
        Default Value:
            For AWS: anthropic.claude-3-haiku-20240307-v1:0
            For Azure: gpt-35-turbo-16k
        Permitted Values:
            *For AWS:
                * anthropic.claude-3-haiku-20240307-v1:0
                * anthropic.claude-instant-v1
                * anthropic.claude-3-5-sonnet-20240620-v1:0
            *For Azure:
                * gpt-35-turbo-16k
            *For NIM:
                * Any hosted chat completion model
        Types: str, TeradataAI
 
    chat_completion_max_tokens:
        Required for NVIDIA NIM, Optional otherwise.
        Specifies the maximum number of tokens to be generated by the
        "chat_completion_model".
        Default Value: 16384
        Permitted Values: [1, 16384]
        Types: int
 
    model_urls:
        Optional Argument.
        Specifies the URL and models to be used for embedding, chat completion
        and guardrails.
        Note:
            * Refer to the ModelUrlParams class for more details.
        Types: ModelUrlParams
 
RETURNS:
    None
 
RAISES:
    TeradataMlException
 
EXAMPLES:
    >>> from langchain_teradata import TeradataVectorStore
    >>> from teradataml import DataFrame
    >>> from teradatagenai import load_data
    >>> load_data("amazon", "amazon_reviews_embedded")
    >>> amazon_reviews_embedded = DataFrame('amazon_reviews_embedded')
 
    # Example 1: Create an instance of an 'embedding-based' vector store by passing the 'amazon_reviews_embedded' table to
    # "data" and "embedding" as 'data_columns'.
    >>> vs_instance = TeradataVectorStore.from_embeddings(name = "vs_example_1",
                                                          data = amazon_reviews_embedded,
                                                          data_columns = ['embedding'])
    >>> load_data("amazon", "amazon_reviews_embedded_10_alter")
    >>> amazon_reviews_embedded_10_alter = DataFrame('amazon_reviews_embedded_10_alter')
    >>> vs_instance.add_embeddings(data=amazon_reviews_embedded_10_alter)
 
    # Example 2: Create a new embedding-based vector store "vs_example_2"
    >>> vs_instance2 = TeradataVectorStore()
    >>> vs_instance2.from_embeddings(name = "vs_example_2",
                                     data = amazon_reviews_embedded_10_alter,
                                     data_columns = ['embedding'])