Skip to content

Commit 9c10d39

Browse files
authored
Merge pull request #21 from BillFarber/main
Various documentation updates
2 parents 6640d1b + ec1d196 commit 9c10d39

File tree

6 files changed

+22
-3
lines changed

6 files changed

+22
-3
lines changed

docs/embedding.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ langchain4j to generate an embedding for the chunk of text and add it to each ch
2929

3030
## Adding embedding to documents
3131

32+
To use this example, you'll need to be in this example directory. If you are not already in this example directory, run
33+
this command:
34+
35+
```
36+
cd embedding-langchain-java
37+
```
38+
3239
To try the embedding example, run the following Gradle task:
3340

3441
../gradlew addEmbeddings

docs/rag-examples/rag-java.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,13 @@ directory demonstrate three different kinds of retrievers that you can consider
2020
The only system requirement for running these examples is Java 8 or higher. You can run the examples via an IDE such as
2121
Visual Code or IntelliJ. You can also use [Gradle](https://gradle.org/) to run the examples, but you do not
2222
need Gradle installed - this repository uses the [Gradle wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html)
23-
to download an appropriate version of Gradle.
23+
to download an appropriate version of Gradle. To start using these examples, you'll need to be in this example
24+
directory. If you are not already in this example directory, run this command:
25+
26+
```
27+
cd rag-langchain-java
28+
```
29+
2430

2531
## RAG with a simple word query
2632

docs/rag-examples/rag-javascript.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ AZURE_OPENAI_API_INSTANCE_NAME=<The host name of your Azure OpenAI endpoint>
3737
Once Node and npm are installed, and your environment is configured, you can run the examples via an IDE such as Visual
3838
Code or IntelliJ. To try these examples, you should first use npm to install the required Node modules:
3939
```
40+
cd rag-langchain-js
4041
npm install
4142
```
4243

docs/splitting.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,13 @@ and leaving the original text documents untouched.
4141
You also need Java 8 in order to run these examples, which is the same version of Java needed by the aforementioned
4242
setup instructions.
4343

44+
Finally, to start using these examples, you'll need to be in this example directory. If you are not already in this
45+
example directory, run this command:
46+
47+
```
48+
cd splitting-langchain-java
49+
```
50+
4451
## Splitting chunks to separate documents
4552

4653
In this approach, the [langchain4j document splitter API](https://docs.langchain4j.dev/tutorials/rag#document-splitter)

setup/docker-compose-12.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
version: '3.8'
21
name: marklogic-12-ai-examples
32

43
services:

setup/docker-compose.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
version: '3.8'
21
name: marklogic-ai-examples
32

43
services:

0 commit comments

Comments
 (0)