/AWS1/CL_S3VINDEX¶
Amazon S3 Vectors is in preview release for Amazon S3 and is subject to change.
The attributes of a vector index.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
iv_vectorbucketname TYPE /AWS1/S3VVECTORBUCKETNAME /AWS1/S3VVECTORBUCKETNAME¶
The name of the vector bucket that contains the vector index.
iv_indexname TYPE /AWS1/S3VINDEXNAME /AWS1/S3VINDEXNAME¶
The name of the vector index.
iv_indexarn TYPE /AWS1/S3VINDEXARN /AWS1/S3VINDEXARN¶
The Amazon Resource Name (ARN) of the vector index.
iv_creationtime TYPE /AWS1/S3VTIMESTAMP /AWS1/S3VTIMESTAMP¶
Date and time when the vector index was created.
iv_datatype TYPE /AWS1/S3VDATATYPE /AWS1/S3VDATATYPE¶
The data type of the vectors inserted into the vector index.
iv_dimension TYPE /AWS1/S3VDIMENSION /AWS1/S3VDIMENSION¶
The number of values in the vectors that are inserted into the vector index.
iv_distancemetric TYPE /AWS1/S3VDISTANCEMETRIC /AWS1/S3VDISTANCEMETRIC¶
The distance metric to be used for similarity search.
Optional arguments:¶
io_metadataconfiguration TYPE REF TO /AWS1/CL_S3VMETADATACONF /AWS1/CL_S3VMETADATACONF¶
The metadata configuration for the vector index.
Queryable Attributes¶
vectorBucketName¶
The name of the vector bucket that contains the vector index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VECTORBUCKETNAME() |
Getter for VECTORBUCKETNAME, with configurable default |
ASK_VECTORBUCKETNAME() |
Getter for VECTORBUCKETNAME w/ exceptions if field has no va |
HAS_VECTORBUCKETNAME() |
Determine if VECTORBUCKETNAME has a value |
indexName¶
The name of the vector index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INDEXNAME() |
Getter for INDEXNAME, with configurable default |
ASK_INDEXNAME() |
Getter for INDEXNAME w/ exceptions if field has no value |
HAS_INDEXNAME() |
Determine if INDEXNAME has a value |
indexArn¶
The Amazon Resource Name (ARN) of the vector index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INDEXARN() |
Getter for INDEXARN, with configurable default |
ASK_INDEXARN() |
Getter for INDEXARN w/ exceptions if field has no value |
HAS_INDEXARN() |
Determine if INDEXARN has a value |
creationTime¶
Date and time when the vector index was created.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATIONTIME() |
Getter for CREATIONTIME, with configurable default |
ASK_CREATIONTIME() |
Getter for CREATIONTIME w/ exceptions if field has no value |
HAS_CREATIONTIME() |
Determine if CREATIONTIME has a value |
dataType¶
The data type of the vectors inserted into the vector index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DATATYPE() |
Getter for DATATYPE, with configurable default |
ASK_DATATYPE() |
Getter for DATATYPE w/ exceptions if field has no value |
HAS_DATATYPE() |
Determine if DATATYPE has a value |
dimension¶
The number of values in the vectors that are inserted into the vector index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DIMENSION() |
Getter for DIMENSION, with configurable default |
ASK_DIMENSION() |
Getter for DIMENSION w/ exceptions if field has no value |
HAS_DIMENSION() |
Determine if DIMENSION has a value |
distanceMetric¶
The distance metric to be used for similarity search.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISTANCEMETRIC() |
Getter for DISTANCEMETRIC, with configurable default |
ASK_DISTANCEMETRIC() |
Getter for DISTANCEMETRIC w/ exceptions if field has no valu |
HAS_DISTANCEMETRIC() |
Determine if DISTANCEMETRIC has a value |
metadataConfiguration¶
The metadata configuration for the vector index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_METADATACONFIGURATION() |
Getter for METADATACONFIGURATION |