Skip to content

Commit

Permalink
feat: update API documentation links in README files (#605)
Browse files Browse the repository at this point in the history
  • Loading branch information
SokiKawashima authored Aug 5, 2024
1 parent dd06df9 commit 48fc40c
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/cdk-lib/amazonaurora/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This construct library provides a class that defines a `AmazonAuroraVectorStore`


## API
See the [API documentation](../../../apidocs/modules/amazonaurora.md).
See the [API documentation](../../../apidocs/namespaces/amazonaurora/README.md).

## Amazon Aurora Vector Store

Expand Down
2 changes: 1 addition & 1 deletion src/cdk-lib/bedrock/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This construct library includes CloudFormation L1 resources to deploy Bedrock fe
- [Agents](#agents)

## API
See the [API documentation](../../../apidocs/modules/bedrock.md).
See the [API documentation](../../../apidocs/namespaces/bedrock/README.md).

## Knowledge Bases
With Knowledge Bases for Amazon Bedrock, you can give FMs and agents contextual information from your company’s private data sources for Retrieval Augmented Generation (RAG) to deliver more relevant, accurate, and customized responses.
Expand Down
2 changes: 1 addition & 1 deletion src/cdk-lib/opensearch-vectorindex/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This construct library provides a resource that creates a vector index on an Ama

## API

See the [API documentation](../../../apidocs/modules/opensearchserverless.md).
See the [API documentation](../../../apidocs/namespaces/opensearch_vectorindex/README.md).

## Vector Index

Expand Down
2 changes: 1 addition & 1 deletion src/cdk-lib/opensearchserverless/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ This construct library extends the [automatically generated L1 constructs](https


## API
See the [API documentation](../../../apidocs/modules/opensearchserverless.md).
See the [API documentation](../../../apidocs/namespaces/opensearchserverless/README.md).

## Vector Collection
This resource creates an Amazon OpenSearch Serverless collection configured for `VECTORSEARCH`. It creates default encryption, network, and data policies for use with Amazon Bedrock Knowledge Bases. For encryption, it uses the default AWS owned KMS key. It allows network connections from the public internet, but access is restricted to specific IAM principals.
Expand Down
2 changes: 1 addition & 1 deletion src/cdk-lib/pinecone/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ This construct library provides a class that defines an existing Pinecone databa
- [Pinecone Vector Store](#pinecone-vector-store)

## API
See the [API documentation](../../../apidocs/modules/pinecone.md).
See the [API documentation](../../../apidocs/namespaces/pinecone/README.md).

## Pinecone Vector Store

Expand Down

0 comments on commit 48fc40c

Please sign in to comment.