Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 14 additions & 6 deletions apidocs/@cdklabs/namespaces/opensearch_vectorindex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,24 @@

# opensearch\_vectorindex

## Enumerations

- [AlgorithmNameType](enumerations/AlgorithmNameType.md)
- [EngineType](enumerations/EngineType.md)
- [OpensearchFieldType](enumerations/OpensearchFieldType.md)
- [SpaceType](enumerations/SpaceType.md)

## Classes

- [VectorIndex](classes/VectorIndex.md)

## Interfaces

- [Analyzer](interfaces/Analyzer.md)
- [MetadataManagementFieldProps](interfaces/MetadataManagementFieldProps.md)
- [IndexSettings](interfaces/IndexSettings.md)
- [IVectorIndex](interfaces/IVectorIndex.md)
- [MappingsProperty](interfaces/MappingsProperty.md)
- [Method](interfaces/Method.md)
- [MethodParameters](interfaces/MethodParameters.md)
- [PropertyMapping](interfaces/PropertyMapping.md)
- [VectorIndexAttributes](interfaces/VectorIndexAttributes.md)
- [VectorIndexProps](interfaces/VectorIndexProps.md)

## Variables

- [OpenSearchIndexCRProvider](variables/OpenSearchIndexCRProvider.md)
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

# Class: VectorIndex

Deploy a vector index on the collection.
Provides a vector index in Amazon OpenSearch Serverless.

## Extends

- `Resource`
- `VectorIndexBase`

## Constructors

Expand Down Expand Up @@ -38,10 +38,22 @@ Deploy a vector index on the collection.

#### Overrides

`cdk.Resource.constructor`
`VectorIndexBase.constructor`

## Properties

### collectionEndpoint

> `readonly` **collectionEndpoint**: `string`

The endpoint of the collection

#### Overrides

`VectorIndexBase.collectionEndpoint`

***

### env

> `readonly` **env**: `ResourceEnvironment`
Expand All @@ -56,7 +68,7 @@ that might be different than the stack they were imported into.

#### Inherited from

`cdk.Resource.env`
`VectorIndexBase.env`

***

Expand All @@ -66,6 +78,10 @@ that might be different than the stack they were imported into.

The name of the index.

#### Overrides

`VectorIndexBase.indexName`

***

### node
Expand All @@ -76,7 +92,7 @@ The tree node.

#### Inherited from

`cdk.Resource.node`
`VectorIndexBase.node`

***

Expand All @@ -95,7 +111,7 @@ This value will resolve to one of the following:

#### Inherited from

`cdk.Resource.physicalName`
`VectorIndexBase.physicalName`

***

Expand All @@ -107,23 +123,7 @@ The stack in which this resource is defined.

#### Inherited from

`cdk.Resource.stack`

***

### vectorDimensions

> `readonly` **vectorDimensions**: `number`

The number of dimensions in the vector.

***

### vectorField

> `readonly` **vectorField**: `string`

The name of the vector field.
`VectorIndexBase.stack`

## Methods

Expand All @@ -144,7 +144,7 @@ through its absolute name/arn.

#### Inherited from

`cdk.Resource._enableCrossEnvironment`
`VectorIndexBase._enableCrossEnvironment`

***

Expand Down Expand Up @@ -174,7 +174,7 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

#### Inherited from

`cdk.Resource.applyRemovalPolicy`
`VectorIndexBase.applyRemovalPolicy`

***

Expand All @@ -188,7 +188,7 @@ account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

#### Inherited from

`cdk.Resource.generatePhysicalName`
`VectorIndexBase.generatePhysicalName`

***

Expand Down Expand Up @@ -228,7 +228,7 @@ cross-environment references to work.

#### Inherited from

`cdk.Resource.getResourceArnAttribute`
`VectorIndexBase.getResourceArnAttribute`

***

Expand Down Expand Up @@ -258,7 +258,7 @@ Commonly this is the resource's `ref`.

#### Inherited from

`cdk.Resource.getResourceNameAttribute`
`VectorIndexBase.getResourceNameAttribute`

***

Expand All @@ -274,7 +274,7 @@ Returns a string representation of this construct.

#### Inherited from

`cdk.Resource.toString`
`VectorIndexBase.toString`

***

Expand Down Expand Up @@ -314,7 +314,7 @@ true if `x` is an object created from a class which extends `Construct`.

#### Inherited from

`cdk.Resource.isConstruct`
`VectorIndexBase.isConstruct`

***

Expand All @@ -336,7 +336,7 @@ Returns true if the construct was created by CDK, and false otherwise

#### Inherited from

`cdk.Resource.isOwnedResource`
`VectorIndexBase.isOwnedResource`

***

Expand All @@ -358,4 +358,4 @@ Check whether the given construct is a Resource

#### Inherited from

`cdk.Resource.isResource`
`VectorIndexBase.isResource`
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)

***

[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [opensearch\_vectorindex](../README.md) / AlgorithmNameType

# Enumeration: AlgorithmNameType

The algorithm name for k-NN search.

## Enumeration Members

### HNSW

> **HNSW**: `"hnsw"`

***

### IVF

> **IVF**: `"ivf"`
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)

***

[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [opensearch\_vectorindex](../README.md) / EngineType

# Enumeration: EngineType

The k-NN search engine to use.

## Enumeration Members

### FAISS

> **FAISS**: `"faiss"`

C++ implementation.

***

### LUCENE

> **LUCENE**: `"lucene"`

Java implementation.

***

### NMSLIB

> **NMSLIB**: `"nmslib"`

C++ implementation.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)

***

[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [opensearch\_vectorindex](../README.md) / OpensearchFieldType

# Enumeration: OpensearchFieldType

The field data type. Must be a valid OpenSearch field type.

## Enumeration Members

### KNN\_VECTOR

> **KNN\_VECTOR**: `"knn_vector"`

***

### TEXT

> **TEXT**: `"text"`
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
[**@cdklabs/generative-ai-cdk-constructs**](../../../../README.md)

***

[@cdklabs/generative-ai-cdk-constructs](../../../../README.md) / [opensearch\_vectorindex](../README.md) / SpaceType

# Enumeration: SpaceType

The distance function used for k-NN search.

## Enumeration Members

### COSINESIMILARITY

> **COSINESIMILARITY**: `"cosinesimil"`

***

### HAMMING

> **HAMMING**: `"hamming"`

***

### INNERPRODUCT

> **INNERPRODUCT**: `"innerproduct"`

***

### L1

> **L1**: `"l1"`

***

### L2

> **L2**: `"l2"`

***

### LINF

> **LINF**: `"linf"`

This file was deleted.

Loading
Loading