libs.teradata.langchain_teradata.TeradataVectorStore.from_embeddings = from_embeddings(name, data, **kwargs) class method of libs.teradata.langchain_teradata.vector_store.TeradataVectorStore

DESCRIPTION:
    Creates a new 'embedding-based' vector store from the
    pre embedded input table(s) or DataFrame(s).
    If vector store already exists, an error is raised.
    Notes:
        * Only admin users can use this method.
        * Refer to the 'Admin Flow' section in the
          User guide for details.
 
PARAMETERS:
    name:
        Required Argument.
        Specifies the name of the vector store to be created from
        input data.
        Types: str
 
    data:
        Required Argument.
        Specifies the table name(s)/teradataml DataFrame(s) that are pre embedded to be
        indexed for 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 or list of str or DataFrame
 
    data_columns:
        Required 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
 
    key_columns:
        Optional Argument.
        Specifies the name(s) of the key column(s) to be used for indexing.
        Types: str, list of str
 
    is_normalized:
        Optional Argument.
        Specifies whether the input contains normalized embeddings.
        Default Value: False
        Types: bool
 
    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:
    VectorStore instance.
 
RAISES:
    TeradataMlException.
 
EXAMPLES:
    # Example 1: Create an instance of an 'embedding-based' vector store 
    #            by passing the 'amazon_reviews_embedded' table to 
    #            "data" and "data_columns" as 'embedding'.
    # Load the amazon reviews embedded data.
    >>> from teradatagenai import VectorStore, load_data
    >>> from teradataml import DataFrame    
    >>> load_data('amazon', 'amazon_reviews_embedded')
    >>> vs_instance = TeradataVectorStore.from_embeddings(name = "vs_example_1",
                                                          data = 'amazon_reviews_embedded',
                                                          data_columns = ['embedding'])
 
    # Example 2: Create an instance of an 'embedding-based' vector store from
    #            embeddings generated using TextAnalyticsAI.
    # Import the required modules.
    >>> import os
    >>> from langchain_teradata import TeradataVectorStore
    >>> from teradatagenai import TeradataAI, TextAnalyticsAI, load_data
    >>> from teradataml import DataFrame
 
    # Load the employee data.
    >>> load_data('employee', 'employee_data')
    >>> data = DataFrame('employee_data')
 
    # Initialize the TeradataAI object using environment variables.
    >>> os.environ["AWS_DEFAULT_REGION"] = "<Enter AWS Region>"
    >>> os.environ["AWS_ACCESS_KEY_ID"] = "<Enter AWS Access Key ID>"
    >>> os.environ["AWS_SECRET_ACCESS_KEY"] = "<Enter AWS Secret Key>"
    >>> llm_embedding = TeradataAI(api_type = "aws",
                                   model_name = "amazon.titan-embed-text-v2:0")
 
    # Create an instance of the TextAnalyticsAI class.
    >>> obj_embeddings = TextAnalyticsAI(llm=llm_embedding)
 
    # Get the embeddings for the 'articles' column in the data.
    >>> TAI_embeddings = obj_embeddings.embeddings(column="articles", 
                                                   data=data,
                                                   accumulate='articles',
                                                   output_format='VECTOR')
 
    # Create an instance of the VectorStore class.
    >>> vs_instance = TeradataVectorStore.from_embeddings(name = "vs_example_2",
                                                          data = TAI_embeddings,
                                                          data_columns = ['Embedding'],
                                                          embedding_data_columns = "articles",
                                                          metadata_columns = ["employee_data", "employee_name"])