Docu: renaming

langchain4j · Feb 9, 2024 · 37b78f2 · 37b78f2
1 parent ad2fd90
commit 37b78f2
Show file tree

Hide file tree

Showing 15 changed files with 60 additions and 60 deletions.
diff --git a/docs/docs/tutorials/1-chat-and-language-models.md b/docs/docs/tutorials/1-chat-and-language-models.md
@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# 1. Chat and Language Models
+# Chat and 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.

diff --git a/docs/docs/tutorials/2-chat-memory.md b/docs/docs/tutorials/2-chat-memory.md
@@ -2,7 +2,7 @@
 sidebar_position: 3
 ---
 
-# 2. Chat Memory
+# Chat Memory
 
 Maintaining and managing `ChatMessage`s manually is cumbersome.
 Therefore, `ChatMemory` exists.

diff --git a/docs/docs/tutorials/3-model-parameters.md b/docs/docs/tutorials/3-model-parameters.md
@@ -2,7 +2,7 @@
 sidebar_position: 4
 ---
 
-# 3. Model Parameters
+# Model Parameters
 
 Depending on the model and provider you choose, you can adjust numerous parameters that will define:
 - The model's output: the level of creativity or determinism in the generated content (text, images),

diff --git a/docs/docs/tutorials/4-response-streaming.md b/docs/docs/tutorials/4-response-streaming.md
@@ -2,7 +2,7 @@
 sidebar_position: 5
 ---
 
-# 4. Response Streaming
+# Response Streaming
 
 LLMs generate text one token at a time, so many LLM providers offer a way to stream the response
 token-by-token instead of waiting for the entire text to be generated.

diff --git a/docs/docs/tutorials/calling-tools.md b/docs/docs/tutorials/calling-tools.md
diff --git a/docs/docs/tutorials/chains.md b/docs/docs/tutorials/chains.md
@@ -2,6 +2,6 @@
 sidebar_position: 14
 ---
 
-# 8. Chains
+# Chains
 
 Coming soon
diff --git a/docs/docs/tutorials/classifier.md → docs/docs/tutorials/classification.md b/docs/docs/tutorials/classifier.md → docs/docs/tutorials/classification.md
@@ -1,10 +1,10 @@
----
-sidebar_position: 12
----
-
-# 6. Classifier
-
-Coming soon
-
-[In-memory embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/other-examples/src/main/java/embedding/store/InMemoryEmbeddingStoreExample.java) (
+---
+sidebar_position: 12
+---
+
+# Classification
+
+Coming soon
+
+[In-memory embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/other-examples/src/main/java/embedding/store/InMemoryEmbeddingStoreExample.java) (
 can be persisted)
diff --git a/docs/docs/tutorials/embedding-store.md → docs/docs/tutorials/embedding-stores.md b/docs/docs/tutorials/embedding-store.md → docs/docs/tutorials/embedding-stores.md
@@ -1,19 +1,19 @@
----
-sidebar_position: 13
----
-
-# 7. Embedding (Vector) Store
-
-- [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)
-- [Example of using Milvus embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/milvus-example/src/main/java/MilvusEmbeddingStoreExample.java)
-- [Example of using Neo4j embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/neo4j-example/src/main/java/Neo4jEmbeddingStoreExample.java)
-- [Example of using OpenSearch embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/opensearch-example/src/main/java/OpenSearchEmbeddingStoreExample.java)
-- [Example of using Pinecone embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/pinecone-example/src/main/java/PineconeEmbeddingStoreExample.java)
-- [Example of using Qdrant embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/qdrant-example/src/main/java/QdrantEmbeddingStoreExample.java)
-- [Example of using Redis embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/redis-example/src/main/java/RedisEmbeddingStoreExample.java)
-- [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)
-
+---
+sidebar_position: 13
+---
+
+# Embedding (Vector) Stores
+
+- [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)
+- [Example of using Milvus embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/milvus-example/src/main/java/MilvusEmbeddingStoreExample.java)
+- [Example of using Neo4j embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/neo4j-example/src/main/java/Neo4jEmbeddingStoreExample.java)
+- [Example of using OpenSearch embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/opensearch-example/src/main/java/OpenSearchEmbeddingStoreExample.java)
+- [Example of using Pinecone embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/pinecone-example/src/main/java/PineconeEmbeddingStoreExample.java)
+- [Example of using Qdrant embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/qdrant-example/src/main/java/QdrantEmbeddingStoreExample.java)
+- [Example of using Redis embedding store](https://github.com/langchain4j/langchain4j-examples/blob/main/redis-example/src/main/java/RedisEmbeddingStoreExample.java)
+- [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)
+
 More info coming soon
diff --git a/docs/docs/tutorials/image-models.md b/docs/docs/tutorials/image-models.md
@@ -2,7 +2,7 @@
 sidebar_position: 21
 ---
 
-# 12. Image Models
+# Image Models
 
 Creating images: example in https://github.com/langchain4j/langchain4j-examples/blob/main/tutorials/src/main/java/_02_OpenAiImageModelExamples.java
 

diff --git a/docs/docs/tutorials/logging.md b/docs/docs/tutorials/logging.md
@@ -2,7 +2,7 @@
 sidebar_position: 30
 ---
 
-# 15. Logging
+# Logging
 
 ### Model requests and responses
 Console output can be switched on and off by setting `.logRequests()` and `.logResponses()` on the model

diff --git a/docs/docs/tutorials/quarkus-integration.md b/docs/docs/tutorials/quarkus-integration.md
@@ -2,6 +2,6 @@
 sidebar_position: 24
 ---
 
-# 13. Quarkus Integration
+# Quarkus Integration
 
 Coming soon
diff --git a/docs/docs/tutorials/chat-with-documents.md → docs/docs/tutorials/rag.md b/docs/docs/tutorials/chat-with-documents.md → docs/docs/tutorials/rag.md
@@ -1,9 +1,9 @@
----
-sidebar_position: 15
----
-
-# 10. Chat with Documents (RAG)
-
-- [Chat with Documents](https://github.com/langchain4j/langchain4j-examples/blob/main/other-examples/src/main/java/ChatWithDocumentsExamples.java)
-
-Coming soon
+---
+sidebar_position: 15
+---
+
+# Chat with Documents (RAG)
+
+- [Chat with Documents](https://github.com/langchain4j/langchain4j-examples/blob/main/other-examples/src/main/java/ChatWithDocumentsExamples.java)
+
+Coming soon
diff --git a/docs/docs/tutorials/spring-boot-integration.md b/docs/docs/tutorials/spring-boot-integration.md
@@ -2,7 +2,7 @@
 sidebar_position: 27
 ---
 
-# 14. Spring Boot Integration
+# Spring Boot Integration
 
 
 ## Compatibility

diff --git a/docs/docs/tutorials/return-pojos.md → ...s/tutorials/structured-data-extraction.md b/docs/docs/tutorials/return-pojos.md → ...s/tutorials/structured-data-extraction.md
@@ -1,9 +1,9 @@
----
-sidebar_position: 11
----
-
-# 5. Return POJOs
-
-[Example of extracting POJOs from text]( https://github.com/langchain4j/langchain4j-examples/blob/337186583f4dc5e4e122b0cdf0a42ddb586c7fe0/other-examples/src/main/java/OtherServiceExamples.java#L133)
-
+---
+sidebar_position: 11
+---
+
+# Structured Data Extraction
+
+[Example of extracting POJOs from text]( https://github.com/langchain4j/langchain4j-examples/blob/337186583f4dc5e4e122b0cdf0a42ddb586c7fe0/other-examples/src/main/java/OtherServiceExamples.java#L133)
+
 More info coming soon
diff --git a/docs/docs/tutorials/tools.md b/docs/docs/tutorials/tools.md
@@ -0,0 +1,7 @@
+---
+sidebar_position: 18
+---
+
+# Tools
+
+Coming soon