Skip to content

Commit 79a3a9d

Browse files
authored
Add llms.txt file for enhanced AI coding tool support (#564)
# Add llms.txt file for enhanced AI coding tool support Fixes #448 ## Summary This PR implements an `llms.txt` file following the standard format to improve developer experience when using AI coding tools like Cursor, Windsurf, and other LLM-powered development environments. ## What is llms.txt? The `llms.txt` standard is being adopted by LangChain, LangGraph, and other AI libraries to provide structured documentation that AI coding tools can easily consume. This helps developers get better code suggestions and more accurate assistance when working with the library. ## Changes - Added `llms.txt` file at the repository root - Organized content into three main sections: - **Guides**: Links to official LangChain AWS integration documentation - **Examples**: Direct links to source code examples in the repository - **Resources**: Links to official AWS documentation and package resources ## Coverage The file covers all major langchain-aws components: - Amazon Bedrock (chat models, LLMs, embeddings) - Amazon SageMaker endpoints - Amazon Kendra retriever - Amazon Bedrock Knowledge Bases - Amazon Neptune graph databases ## Benefits - Improved AI coding assistant accuracy when working with langchain-aws - Better code completion and suggestions - Enhanced developer onboarding experience - Standardized documentation format for AI tools ## References - [llms.txt overview and standard](https://langchain-ai.github.io/langgraph/llms-txt-overview/) - [LangGraph llms.txt example](https://github.com/langchain-ai/langgraph/blob/main/llms.txt)
1 parent c924ee5 commit 79a3a9d

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

llms.txt

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Guides
2+
3+
- [LangChain AWS Integration Documentation](https://python.langchain.com/docs/integrations/platforms/aws/): Comprehensive guide covering all AWS integrations with LangChain, including chat models, LLMs, embeddings, retrievers, and vector stores. This page provides installation instructions, usage examples, and detailed configuration options for Amazon Bedrock, SageMaker, Kendra, Neptune, and other AWS services.
4+
- [Amazon Bedrock Chat Models](https://python.langchain.com/docs/integrations/chat/bedrock/): This guide explains how to use Amazon Bedrock foundation models through the ChatBedrock interface. It covers model initialization, parameter configuration, streaming responses, and tool calling capabilities. Includes examples for Anthropic Claude, AI21 Jurassic, Cohere Command, Meta Llama, and Amazon Titan models.
5+
- [Amazon Bedrock LLMs](https://python.langchain.com/docs/integrations/llms/bedrock/): Documentation for using Amazon Bedrock language models with the BedrockLLM class. Covers model selection, parameter tuning, credential configuration, and integration with LangChain applications. Includes examples for various foundation models available through Bedrock.
6+
- [Amazon Bedrock Embeddings](https://python.langchain.com/docs/integrations/text_embedding/bedrock/): Guide for implementing text embeddings using Amazon Bedrock embedding models. Covers the BedrockEmbeddings class, model configuration, batch processing, and integration with vector stores. Includes examples using Amazon Titan and Cohere embedding models.
7+
- [Amazon SageMaker Endpoints](https://python.langchain.com/docs/integrations/llms/sagemaker/): Instructions for deploying and using custom models on Amazon SageMaker endpoints with LangChain. Covers endpoint configuration, content handlers, custom model deployment, and real-time inference setup.
8+
- [Amazon Kendra Retriever](https://python.langchain.com/docs/integrations/retrievers/amazon_kendra_retriever/): Documentation for integrating Amazon Kendra enterprise search with LangChain applications. Covers index setup, query configuration, document retrieval, and filtering options. Includes examples for building RAG applications with Kendra as the knowledge base.
9+
- [Amazon Bedrock Knowledge Bases Retriever](https://python.langchain.com/docs/integrations/retrievers/bedrock/): Guide for using Amazon Bedrock Knowledge Bases as a retriever in RAG applications. Covers knowledge base setup, retrieval configuration, vector search parameters, and integration with Bedrock foundation models.
10+
- [Amazon Neptune Graph Database](https://python.langchain.com/docs/integrations/graphs/neptune_cypher/): Documentation for working with Amazon Neptune graph databases using Cypher queries. Covers graph connection setup, query execution, and integration with LangChain graph capabilities for knowledge graphs and graph-based AI applications.
11+
- [Amazon Neptune Analytics](https://python.langchain.com/docs/integrations/graphs/neptune_cypher/): Guide for using Amazon Neptune Analytics for serverless graph analytics. Covers graph identifier configuration, query optimization, and integration with graph-based AI workflows.
12+
13+
# Examples
14+
15+
- [Amazon Bedrock Chat Example](https://github.com/langchain-ai/langchain-aws/blob/main/libs/aws/langchain_aws/chat_models/bedrock.py): Source code example showing how to implement and use the ChatBedrock class for conversational AI applications. Demonstrates parameter configuration, streaming responses, and tool calling capabilities with various foundation models.
16+
- [Amazon Bedrock LLM Example](https://github.com/langchain-ai/langchain-aws/blob/main/libs/aws/langchain_aws/llms/bedrock.py): Implementation example of the BedrockLLM class showing model initialization, parameter configuration, and integration with LangChain workflows. Includes examples for different foundation models and use cases.
17+
- [Amazon Bedrock Embeddings Example](https://github.com/langchain-ai/langchain-aws/blob/main/libs/aws/langchain_aws/embeddings/bedrock.py): Source code demonstrating how to use BedrockEmbeddings for text embedding generation. Shows model configuration, batch processing, and integration with vector stores and retrieval systems.
18+
- [Amazon Kendra Retriever Example](https://github.com/langchain-ai/langchain-aws/blob/main/libs/aws/langchain_aws/retrievers/kendra.py): Implementation example of the AmazonKendraRetriever class showing how to set up enterprise search capabilities. Demonstrates index configuration, query processing, and document retrieval for RAG applications.
19+
- [Amazon Knowledge Bases Retriever Example](https://github.com/langchain-ai/langchain-aws/blob/main/libs/aws/langchain_aws/retrievers/bedrock.py): Source code example for the AmazonKnowledgeBasesRetriever class. Shows configuration of vector search parameters, knowledge base integration, and retrieval optimization for Bedrock-based RAG systems.
20+
- [Amazon SageMaker Endpoint Example](https://github.com/langchain-ai/langchain-aws/blob/main/libs/aws/langchain_aws/llms/sagemaker_endpoint.py): Implementation example showing how to deploy and use custom models on SageMaker endpoints. Demonstrates content handler configuration, endpoint management, and real-time inference integration.
21+
- [Amazon Neptune Graph Example](https://github.com/langchain-ai/langchain-aws/blob/main/libs/aws/langchain_aws/graphs/neptune_graph.py): Source code example for working with Neptune graph databases. Shows graph connection setup, Cypher query execution, and integration with graph-based AI applications.
22+
23+
# Resources
24+
25+
- [LangChain AWS GitHub Repository](https://github.com/langchain-ai/langchain-aws): Official repository for the langchain-aws package containing source code, documentation, and examples. Includes installation instructions, contribution guidelines, and issue tracking for AWS integrations with LangChain.
26+
- [LangChain AWS PyPI Package](https://pypi.org/project/langchain-aws/): Official Python package for installing langchain-aws. Contains version history, dependency information, and installation instructions for integrating AWS services with LangChain applications.
27+
- [Amazon Bedrock Documentation](https://docs.aws.amazon.com/bedrock/): Official AWS documentation for Amazon Bedrock foundation models. Covers model capabilities, API reference, pricing, and best practices for using foundation models from various providers including Anthropic, AI21 Labs, Cohere, Meta, and Amazon.
28+
- [Amazon SageMaker Documentation](https://docs.aws.amazon.com/sagemaker/): Comprehensive documentation for Amazon SageMaker machine learning platform. Includes guides for model training, deployment, endpoint management, and integration with custom ML workflows.
29+
- [Amazon Kendra Documentation](https://docs.aws.amazon.com/kendra/): Official documentation for Amazon Kendra enterprise search service. Covers index creation, data source connectors, search configuration, and enterprise search best practices.
30+
- [Amazon Neptune Documentation](https://docs.aws.amazon.com/neptune/): Documentation for Amazon Neptune graph database service. Includes guides for graph creation, query languages (Gremlin and SPARQL), performance optimization, and graph analytics capabilities.

0 commit comments

Comments
 (0)