Skip to content

Commit

Permalink
improve docu
Browse files Browse the repository at this point in the history
  • Loading branch information
langchain4j committed Jun 12, 2024
1 parent 97065bc commit 050a5be
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 5 deletions.
4 changes: 4 additions & 0 deletions docs/docs/tutorials/1-chat-and-language-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ This page describes a low-level LLM API.
See [AI Services](/tutorials/ai-services) for a high-level LLM API.
:::

:::note
All supported LLMs can be found [here](/integrations/language-models).
:::

LLMs are currently available in two API types:
- `LanguageModel`s. Their API is very simple - they accept a `String` as input and return a `String` as output.
This API is now becoming obsolete in favor of chat API (second API type).
Expand Down
7 changes: 5 additions & 2 deletions docs/docs/tutorials/embedding-stores.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ sidebar_position: 13

# Embedding (Vector) Stores

Documentation on embedding stores can be found [here](/tutorials/rag#embedding-store).

All supported embedding stores can be found [here](/integrations/embedding-stores/).

## Examples
- [Example of using in-memory embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/other-examples/src/main/java/embedding/store/InMemoryEmbeddingStoreExample.java)
- [Example of using Chroma embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/chroma-example/src/main/java/ChromaEmbeddingStoreExample.java)
- [Example of using Elasticsearch embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/elasticsearch-example/src/main/java/ElasticsearchEmbeddingStoreExample.java)
Expand All @@ -16,5 +21,3 @@ sidebar_position: 13
- [Example of using Vespa embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/vespa-example/src/main/java/VespaEmbeddingStoreExample.java)
- [Example of using Weaviate embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/weaviate-example/src/main/java/WeaviateEmbeddingStoreExample.java)
- [Example of using PGVector embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/pgvector-example/src/main/java/PgVectorEmbeddingStoreExample.java)

More info coming soon
2 changes: 1 addition & 1 deletion docs/docs/tutorials/structured-data-extraction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 11

# Structured Data Extraction

More info coming soon
Documentation on structured data extraction can be found [here](/tutorials/ai-services#output-parsing-aka-structured-outputs).

## Examples

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,14 @@
/**
* Represents a store for the {@link ChatMemory} state.
* Allows for flexibility in terms of where and how chat memory is stored.
* Currently, the only implementation available is {@link InMemoryChatMemoryStore}. We are in the process of adding
* ready implementations for popular stores like SQL DBs, document stores, etc.
* <br>
* <br>
* Currently, the only implementation available is {@link InMemoryChatMemoryStore}.
* Over time, out-of-the-box implementations will be added for popular stores like SQL databases, document stores, etc.
* In the meantime, you can implement this interface to connect to any storage of your choice.
* <br>
* <br>
* More documentation can be found <a href="https://docs.langchain4j.dev/tutorials/chat-memory">here</a>.
*/
public interface ChatMemoryStore {

Expand Down

0 comments on commit 050a5be

Please sign in to comment.