Skip to content

Commit

Permalink
docs: Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmigloz committed Nov 2, 2023
1 parent 273cfa2 commit af7ee82
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 23 deletions.
33 changes: 17 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ The components can be grouped into a few core modules:

- πŸ“ƒ **Model I/O:** streamlines the interaction between the model inputs (prompt templates), the
Language Model (abstracting different providers), and the model output (output parsers).
- πŸ“š **Data Connection:** assists in loading user data (document loaders), modifying it (document
transformers), storing (via text embedding models and vector stores), and retrieving when needed
- πŸ“š **Retrieval:** assists in loading user data (document loaders), modifying it (document
transformers and embedding models), storing (vector stores), and retrieving when needed
(retrievers).
- πŸ”— **Chains:** a way to compose multiple components or other chains into a single pipeline.
- 🧠 **Memory:** equips chains or agents with both short-term and long-term memory capabilities,
Expand Down Expand Up @@ -69,10 +69,11 @@ provided by a separate package.
The following packages are maintained (and used internally) by LangChain.dart,
although they can also be used independently:

| Package | Version | Description |
|-------------------------------------------------|------------------------------------------------------------------------------------------------|--------------------------|
| [chromadb](https://pub.dev/packages/chromadb) | [![chromadb](https://img.shields.io/pub/v/chromadb.svg)](https://pub.dev/packages/chromadb) | Chroma DB API client |
| [vertex_ai](https://pub.dev/packages/vertex_ai) | [![vertex_ai](https://img.shields.io/pub/v/vertex_ai.svg)](https://pub.dev/packages/vertex_ai) | GCP Vertex AI API client |
| Package | Version | Description |
|-----------------------------------------------------|------------------------------------------------------------------------------------------------------|--------------------------|
| [chromadb](https://pub.dev/packages/chromadb) | [![chromadb](https://img.shields.io/pub/v/chromadb.svg)](https://pub.dev/packages/chromadb) | Chroma DB API client |
| [openai_dart](https://pub.dev/packages/openai_dart) | [![openai_dart](https://img.shields.io/pub/v/openai_dart.svg)](https://pub.dev/packages/openai_dart) | OpenAI API client |
| [vertex_ai](https://pub.dev/packages/vertex_ai) | [![vertex_ai](https://img.shields.io/pub/v/vertex_ai.svg)](https://pub.dev/packages/vertex_ai) | GCP Vertex AI API client |

## Getting started

Expand Down Expand Up @@ -108,16 +109,16 @@ final model = ChatOpenAI(apiKey: openaiApiKey);
const stringOutputParser = StringOutputParser();
final chain = Runnable.fromMap({
'city': promptTemplate1 | model | stringOutputParser,
'language': Runnable.getItemFromMap('language'),
}) |
promptTemplate2 |
model |
stringOutputParser;
'city': promptTemplate1 | model | stringOutputParser,
'language': Runnable.getItemFromMap('language'),
}) |
promptTemplate2 |
model |
stringOutputParser;
final res = await chain.invoke({
'person': 'Rafael Nadal',
'language': 'Spanish',
'person': 'Rafael Nadal',
'language': 'Spanish',
});
print(res);
// La ciudad de Manacor se encuentra en EspaΓ±a.
Expand Down Expand Up @@ -150,8 +151,8 @@ your first contribution in no time!

## Related projects

- [LangChain](https://github.com/hwchase17/langchain): The original Python LangChain project.
- [LangChain.js](https://github.com/hwchase17/langchainjs): A JavaScript port of LangChain.
- [LangChain](https://github.com/langchain-ai/langchain): The original Python LangChain project.
- [LangChain.js](https://github.com/langchain-ai/langchainjs): A JavaScript port of LangChain.
- [LangChain.go](https://github.com/tmc/langchaingo): A Go port of LangChain.
- [LangChain.rb](https://github.com/andreibondarev/langchainrb): A Ruby port of LangChain.

Expand Down
Binary file modified docs/img/langchain.dart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 7 additions & 6 deletions packages/langchain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ The components can be grouped into a few core modules:

- πŸ“ƒ **Model I/O:** streamlines the interaction between the model inputs (prompt templates), the
Language Model (abstracting different providers), and the model output (output parsers).
- πŸ“š **Data Connection:** assists in loading user data (document loaders), modifying it (document
transformers), storing (via text embedding models and vector stores), and retrieving when needed
- πŸ“š **Retrieval:** assists in loading user data (document loaders), modifying it (document
transformers and embedding models), storing (vector stores), and retrieving when needed
(retrievers).
- πŸ”— **Chains:** a way to compose multiple components or other chains into a single pipeline.
- 🧠 **Memory:** equips chains or agents with both short-term and long-term memory capabilities,
Expand Down Expand Up @@ -69,10 +69,11 @@ provided by a separate package.
The following packages are maintained (and used internally) by LangChain.dart,
although they can also be used independently:

| Package | Version | Description |
|-------------------------------------------------|------------------------------------------------------------------------------------------------|--------------------------|
| [chromadb](https://pub.dev/packages/chromadb) | [![chromadb](https://img.shields.io/pub/v/chromadb.svg)](https://pub.dev/packages/chromadb) | Chroma DB API client |
| [vertex_ai](https://pub.dev/packages/vertex_ai) | [![vertex_ai](https://img.shields.io/pub/v/vertex_ai.svg)](https://pub.dev/packages/vertex_ai) | GCP Vertex AI API client |
| Package | Version | Description |
|-----------------------------------------------------|------------------------------------------------------------------------------------------------------|--------------------------|
| [chromadb](https://pub.dev/packages/chromadb) | [![chromadb](https://img.shields.io/pub/v/chromadb.svg)](https://pub.dev/packages/chromadb) | Chroma DB API client |
| [openai_dart](https://pub.dev/packages/openai_dart) | [![openai_dart](https://img.shields.io/pub/v/openai_dart.svg)](https://pub.dev/packages/openai_dart) | OpenAI API client |
| [vertex_ai](https://pub.dev/packages/vertex_ai) | [![vertex_ai](https://img.shields.io/pub/v/vertex_ai.svg)](https://pub.dev/packages/vertex_ai) | GCP Vertex AI API client |

## Getting started

Expand Down
2 changes: 1 addition & 1 deletion packages/langchain/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ dependencies:
collection: ^1.17.1
crypto: ^3.0.3
cross_file: ^0.3.3+4
csv: ^5.0.2
csv: ^5.1.0
http: ^1.1.0
json_path: ^0.6.2
math_expressions: ^2.4.0
Expand Down

0 comments on commit af7ee82

Please sign in to comment.