Skip to content

/AWS1/CL_DYNVECTORINDEX

Contains the configuration settings for a vector index, including the index name, vector attribute, dimensions, distance function, search schema, and projection.

CONSTRUCTOR

IMPORTING

Required arguments:

iv_indexname TYPE /AWS1/DYNINDEXNAME /AWS1/DYNINDEXNAME

The name of the vector index.

io_vectorattribute TYPE REF TO /AWS1/CL_DYNVECTORATTRDEFN /AWS1/CL_DYNVECTORATTRDEFN

The vector attribute configuration for the 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.

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. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

Optional arguments:

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.


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

VectorAttribute

The vector attribute configuration for the index.

Accessible with the following methods

Method Description
GET_VECTORATTRIBUTE() Getter for VECTORATTRIBUTE

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

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. Valid values: COSINE, EUCLIDEAN, DOT_PRODUCT.

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

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_VECTORINDEXLIST

TYPES TT_VECTORINDEXLIST TYPE STANDARD TABLE OF REF TO /AWS1/CL_DYNVECTORINDEX WITH DEFAULT KEY
.