Method●Since v0.2

from_texts

Return AmazonS3Vectors initialized from texts and embeddings.

from_texts(
  cls: type[AmazonS3Vectors],
  texts: list[str],
  embedding: Embeddings,
  metadatas: Optional[list[dict]] = None,
  *,
  ids: Optional[list[str]] = None,
  vector_bucket_name: str,
  index_name: str,
  data_type: Literal['float32'] = 'float32',
  distance_metric: Literal['euclidean', 'cosine'] = 'cosine',
  non_filterable_metadata_keys: list[str] | None = None,
  page_content_metadata_key: Optional[str] = '_page_content',
  create_index_if_not_exist: bool = True,
  relevance_score_fn: Optional[Callable[[float], float]] = None,
  region_name: Optional[str] = None,
  credentials_profile_name: Optional[str] = None,
  aws_access_key_id: Optional[str] = None,
  aws_secret_access_key: Optional[str] = None,
  aws_session_token: Optional[str] = None,
  endpoint_url: Optional[str] = None,
  config: Any = None,
  client: Any = None,
  **kwargs: Any = {}
) -> AmazonS3Vectors

Parameters

Name	Type	Description
`texts`*	`list[str]`	Texts to add to the `VectorStore`.
`embedding`*	`Embeddings`	Embedding function to use.
`metadatas`	`Optional[list[dict]]`	Default:`None` Optional list of metadatas associated with the texts. Default is None.
`ids`	`Optional[list[str]]`	Default:`None` Optional list of IDs associated with the texts.
`vector_bucket_name`*	`str`	The name of an existing S3 vector bucket
`index_name`*	`str`	The name of the S3 vector index. The index names must be 3 to 63 characters long, start and end with a letter or number, and contain only lowercase letters, numbers, hyphens and dots.
`data_type`	`Literal['float32']`	Default:`'float32'` The data type of the vectors to be inserted into the vector index. Default is "float32".
`distance_metric`	`Literal['euclidean', 'cosine']`	Default:`'cosine'` The distance metric to be used for similarity search. Default is "cosine".
`non_filterable_metadata_keys`	`list[str] \| None`	Default:`None` Non-filterable metadata keys
`page_content_metadata_key`	`Optional[str]`	Default:`'_page_content'` Key of metadata to store page_content in Document. If None, embedding page_content but stored as an empty string. Default is "_page_content".
`create_index_if_not_exist`	`bool`	Default:`True` Automatically create vector index if it does not exist. Default is True.
`relevance_score_fn`	`Optional[Callable[[float], float]]`	Default:`None` The 'correct' relevance function.
`region_name`	`Optional[str]`	Default:`None` The aws region where the Sagemaker model is deployed, eg. `us-west-2`.
`credentials_profile_name`	`Optional[str]`	Default:`None` The name of the profile in the ~/.aws/credentials or ~/.aws/config files, which has either access keys or role information specified. If not specified, the default credential profile or, if on an EC2 instance, credentials from IMDS will be used. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html
`aws_access_key_id`	`Optional[str]`	Default:`None` AWS access key id. If provided, aws_secret_access_key must also be provided. If not specified, the default credential profile or, if on an EC2 instance, credentials from IMDS will be used. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html If not provided, will be read from `AWS_ACCESS_KEY_ID` environment variable.
`aws_secret_access_key`	`Optional[str]`	Default:`None` AWS secret_access_key. If provided, aws_access_key_id must also be provided. If not specified, the default credential profile or, if on an EC2 instance, credentials from IMDS will be used. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html If not provided, will be read from `AWS_SECRET_ACCESS_KEY` environment variable.
`aws_session_token`	`Optional[str]`	Default:`None` AWS session token. If provided, aws_access_key_id and aws_secret_access_key must also be provided. Not required unless using temporary credentials. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html If not provided, will be read from `AWS_SESSION_TOKEN` environment variable.
`endpoint_url`	`Optional[str]`	Default:`None` Needed if you don't want to default to us-east-1 endpoint
`config`	`Any`	Default:`None` An optional `botocore.config.Config` instance to pass to the client.
`client`	`Any`	Default:`None` Boto3 client for s3vectors
`kwargs`	`Any`	Default:`{}` Arguments to pass to AmazonS3Vectors.

View source on GitHub

from_texts( cls: type[AmazonS3Vectors], texts: list[str], embedding: Embeddings, metadatas: Optional[list[dict]] = None, *, ids: Optional[list[str]] = None, vector_bucket_name: str, index_name: str, data_type: Literal['float32'] = 'float32', distance_metric: Literal['euclidean', 'cosine'] = 'cosine', non_filterable_metadata_keys: list[str] | None = None, page_content_metadata_key: Optional[str] = '_page_content', create_index_if_not_exist: bool = True, relevance_score_fn: Optional[Callable[[float], float]] = None, region_name: Optional[str] = None, credentials_profile_name: Optional[str] = None, aws_access_key_id: Optional[str] = None, aws_secret_access_key: Optional[str] = None, aws_session_token: Optional[str] = None, endpoint_url: Optional[str] = None, config: Any = None, client: Any = None, **kwargs: Any = {} ) -> AmazonS3Vectors

Parameters

Name	Type	Description
`texts`*	`list[str]`	Texts to add to the `VectorStore`.
`embedding`*	`Embeddings`	Embedding function to use.
`metadatas`	`Optional[list[dict]]`	Default:`None` Optional list of metadatas associated with the texts. Default is None.
`ids`	`Optional[list[str]]`	Default:`None` Optional list of IDs associated with the texts.
`vector_bucket_name`*	`str`	The name of an existing S3 vector bucket
`index_name`*	`str`	The name of the S3 vector index. The index names must be 3 to 63 characters long, start and end with a letter or number, and contain only lowercase letters, numbers, hyphens and dots.
`data_type`	`Literal['float32']`	Default:`'float32'` The data type of the vectors to be inserted into the vector index. Default is "float32".
`distance_metric`	`Literal['euclidean', 'cosine']`	Default:`'cosine'` The distance metric to be used for similarity search. Default is "cosine".
`non_filterable_metadata_keys`	`list[str] \| None`	Default:`None` Non-filterable metadata keys
`page_content_metadata_key`	`Optional[str]`	Default:`'_page_content'` Key of metadata to store page_content in Document. If None, embedding page_content but stored as an empty string. Default is "_page_content".
`create_index_if_not_exist`	`bool`	Default:`True` Automatically create vector index if it does not exist. Default is True.
`relevance_score_fn`	`Optional[Callable[[float], float]]`	Default:`None` The 'correct' relevance function.
`region_name`	`Optional[str]`	Default:`None` The aws region where the Sagemaker model is deployed, eg. `us-west-2`.
`credentials_profile_name`	`Optional[str]`	Default:`None` The name of the profile in the ~/.aws/credentials or ~/.aws/config files, which has either access keys or role information specified. If not specified, the default credential profile or, if on an EC2 instance, credentials from IMDS will be used. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html
`aws_access_key_id`	`Optional[str]`	Default:`None` AWS access key id. If provided, aws_secret_access_key must also be provided. If not specified, the default credential profile or, if on an EC2 instance, credentials from IMDS will be used. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html If not provided, will be read from `AWS_ACCESS_KEY_ID` environment variable.
`aws_secret_access_key`	`Optional[str]`	Default:`None` AWS secret_access_key. If provided, aws_access_key_id must also be provided. If not specified, the default credential profile or, if on an EC2 instance, credentials from IMDS will be used. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html If not provided, will be read from `AWS_SECRET_ACCESS_KEY` environment variable.
`aws_session_token`	`Optional[str]`	Default:`None` AWS session token. If provided, aws_access_key_id and aws_secret_access_key must also be provided. Not required unless using temporary credentials. See: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html If not provided, will be read from `AWS_SESSION_TOKEN` environment variable.
`endpoint_url`	`Optional[str]`	Default:`None` Needed if you don't want to default to us-east-1 endpoint
`config`	`Any`	Default:`None` An optional `botocore.config.Config` instance to pass to the client.
`client`	`Any`	Default:`None` Boto3 client for s3vectors
`kwargs`	`Any`	Default:`{}` Arguments to pass to AmazonS3Vectors.

from_texts

Parameters

LangChain Assistant

Menu

from_texts

Parameters