/AWS1/CL_DYNVECTORINDEXDESC¶
Contains the current state and configuration of a vector index, including its status, size, item count, and the settings specified when the index was created.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_indexname TYPE /AWS1/DYNINDEXNAME /AWS1/DYNINDEXNAME¶
The name of the vector index.
it_searchschema TYPE /AWS1/CL_DYNSEARCHSCHEMAELEM=>TT_SEARCHSCHEMA TT_SEARCHSCHEMA¶
The search schema that defines partition key and inline filter attributes for the vector index.
io_projection TYPE REF TO /AWS1/CL_DYNPROJECTION /AWS1/CL_DYNPROJECTION¶
Specifies attributes that are copied (projected) from the table into the vector index.
io_vectorattribute TYPE REF TO /AWS1/CL_DYNVECTORATTRDEFN /AWS1/CL_DYNVECTORATTRDEFN¶
The vector attribute configuration for the index.
iv_dimensions TYPE /AWS1/DYNPOSITIVELONGOBJECT /AWS1/DYNPOSITIVELONGOBJECT¶
The number of dimensions in each vector.
iv_distancefunction TYPE /AWS1/DYNVECTORDISTANCEFUNC /AWS1/DYNVECTORDISTANCEFUNC¶
The distance function used to calculate similarity between vectors.
iv_indexstatus TYPE /AWS1/DYNINDEXSTATUS /AWS1/DYNINDEXSTATUS¶
The current state of the vector index:
CREATING- The index is being created.
ACTIVE- The index is ready for use.
DELETING- The index is being deleted.
iv_backfilling TYPE /AWS1/DYNBACKFILLING /AWS1/DYNBACKFILLING¶
Specifies whether the index is currently backfilling. During backfill,
SearchVectorsoperations might return incomplete results.
iv_indexsizebytes TYPE /AWS1/DYNLONGOBJECT /AWS1/DYNLONGOBJECT¶
The total size of the vector index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
iv_itemcount TYPE /AWS1/DYNLONGOBJECT /AWS1/DYNLONGOBJECT¶
The number of items indexed in the vector index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
iv_indexarn TYPE /AWS1/DYNSTRING /AWS1/DYNSTRING¶
The Amazon Resource Name (ARN) that uniquely identifies the vector index.
Queryable Attributes¶
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 |
SearchSchema¶
The search schema that defines partition key and inline filter attributes for the vector index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SEARCHSCHEMA() |
Getter for SEARCHSCHEMA, with configurable default |
ASK_SEARCHSCHEMA() |
Getter for SEARCHSCHEMA w/ exceptions if field has no value |
HAS_SEARCHSCHEMA() |
Determine if SEARCHSCHEMA has a value |
Projection¶
Specifies attributes that are copied (projected) from the table into the vector index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROJECTION() |
Getter for PROJECTION |
VectorAttribute¶
The vector attribute configuration for the index.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VECTORATTRIBUTE() |
Getter for VECTORATTRIBUTE |
Dimensions¶
The number of dimensions in each vector.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DIMENSIONS() |
Getter for DIMENSIONS, with configurable default |
ASK_DIMENSIONS() |
Getter for DIMENSIONS w/ exceptions if field has no value |
HAS_DIMENSIONS() |
Determine if DIMENSIONS has a value |
DistanceFunction¶
The distance function used to calculate similarity between vectors.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DISTANCEFUNCTION() |
Getter for DISTANCEFUNCTION, with configurable default |
ASK_DISTANCEFUNCTION() |
Getter for DISTANCEFUNCTION w/ exceptions if field has no va |
HAS_DISTANCEFUNCTION() |
Determine if DISTANCEFUNCTION has a value |
IndexStatus¶
The current state of the vector index:
CREATING- The index is being created.
ACTIVE- The index is ready for use.
DELETING- The index is being deleted.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INDEXSTATUS() |
Getter for INDEXSTATUS, with configurable default |
ASK_INDEXSTATUS() |
Getter for INDEXSTATUS w/ exceptions if field has no value |
HAS_INDEXSTATUS() |
Determine if INDEXSTATUS has a value |
Backfilling¶
Specifies whether the index is currently backfilling. During backfill,
SearchVectorsoperations might return incomplete results.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BACKFILLING() |
Getter for BACKFILLING, with configurable default |
ASK_BACKFILLING() |
Getter for BACKFILLING w/ exceptions if field has no value |
HAS_BACKFILLING() |
Determine if BACKFILLING has a value |
IndexSizeBytes¶
The total size of the vector index, in bytes. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INDEXSIZEBYTES() |
Getter for INDEXSIZEBYTES, with configurable default |
ASK_INDEXSIZEBYTES() |
Getter for INDEXSIZEBYTES w/ exceptions if field has no valu |
HAS_INDEXSIZEBYTES() |
Determine if INDEXSIZEBYTES has a value |
ItemCount¶
The number of items indexed in the vector index. Amazon DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ITEMCOUNT() |
Getter for ITEMCOUNT, with configurable default |
ASK_ITEMCOUNT() |
Getter for ITEMCOUNT w/ exceptions if field has no value |
HAS_ITEMCOUNT() |
Determine if ITEMCOUNT has a value |
IndexArn¶
The Amazon Resource Name (ARN) that uniquely identifies 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 |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_VECTORINDEXDESCRIPTIONLIST¶
TYPES TT_VECTORINDEXDESCRIPTIONLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_DYNVECTORINDEXDESC WITH DEFAULT KEY
.