Spring/spring-ai
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

update docs

Browse Source
This commit is contained in:
Mark Pollack
2023-08-21 08:16:05 -07:00
parent 8b0ad1a183
commit e3da80d86e
18 changed files with 133 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -31,8 +31,11 @@ Taking inspiration from these libraries, the Spring AI project aims to provide a
The following is a feature list resembling those found in the LangChain documentation.
The initial features lay the foundation, with subsequent, more complex features building upon them.
Implemented features are linked to the Spring AI documentation.
Features without links are part of our future roadmap.
You can find more details in the [Reference Documentation](https://docs.spring.io/spring-ai/reference/)
Not all features listed here are implemented yet, but a good amount are :)
### Model I/O
@@ -82,7 +85,7 @@ It's getting a bit funky, isn't it?
## Project Links
* [Issues](https://github.com/spring-projects-experimental/spring-ai/issues)
* Documentation
* [Documentation](https://docs.spring.io/spring-ai/reference/)
* [JavaDocs](https://docs.spring.io/spring-ai/docs/current-SNAPSHOT/)
## Building

14
spring-ai-docs/src/main/antora/modules/ROOT/nav.adoc
View File

@@ -1,8 +1,16 @@
* xref:index.adoc[Overview]
* xref:concepts.adoc[AI Concepts]
* xref:getting-started.adoc[Getting Started]
* xref:prompt/index.adoc[]
* xref:client/index.adoc[]
** xref:client/usage.adoc[]
* xref:api/index.adoc[]
** xref:api/models.adoc[]
** xref:api/prompt.adoc[]
** xref:api/prompt-template.adoc[]
** xref:api/output-parser.adoc[]
** xref:api/chains.adoc[]
** xref:api/dataloaders.adoc[]
** xref:api/splitters.adoc[]
** xref:api/embeddings.adoc[]
** xref:api/vectordbs.adoc[]
** xref:api/evaluators.adoc[]
* Appendices
** xref:glossary.adoc[]

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chains.adoc Normal file
View File

@@ -0,0 +1,3 @@
= Chains
TBD

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/dataloaders.adoc Normal file
View File

@@ -0,0 +1,3 @@
= Data Loaders
TBD

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings.adoc Normal file
View File

@@ -0,0 +1,3 @@
= Embeddings
TBD

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/evaluators.adoc Normal file
View File

@@ -0,0 +1,3 @@
= Evaluators
TBD

5
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/index.adoc Normal file
View File

@@ -0,0 +1,5 @@
= Spring AI API
== Introduction
The following sections introduce each part of the API.

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/models.adoc Normal file
View File

@@ -0,0 +1,3 @@
= Models
TBD

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/output-parser.adoc Normal file
View File

@@ -0,0 +1,3 @@
= Output Parsers
TBD

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/prompt-template.adoc Normal file
View File

@@ -0,0 +1,3 @@
= Prompt Templates
TBD

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/prompt.adoc Normal file
View File

@@ -0,0 +1,3 @@
= Prompt
TBD

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/splitters.adoc Normal file
View File

@@ -0,0 +1,3 @@
= Splitters
TBD

1
spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs.adoc Normal file
View File

@@ -0,0 +1 @@
= Vector Databases

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/client/index.adoc
View File

@@ -1,3 +0,0 @@
= Configuring an AiClient
TBD

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/client/usage.adoc
View File

@@ -1,3 +0,0 @@
= Using AiClient
TBD

6
spring-ai-docs/src/main/antora/modules/ROOT/pages/concepts.adoc
View File

@@ -152,10 +152,14 @@ Data Loaders and Vector Database are the fundamental building blocks for solving
=== Data Loaders
TBD
=== Splitters
=== Embeddings
=== Vector Databases
TBD
== Evaluating AI responses
Effectively evaluating the output of an AI system in response to user requests is very important to ensuring accuracy and usefulness of the final application.

78
spring-ai-docs/src/main/antora/modules/ROOT/pages/getting-started.adoc
View File

@@ -28,6 +28,84 @@ export SPRING_AI_AZURE_OPENAI_API_KEY=<INSERT KEY HERE>
export SPRING_AI_AZURE_OPENAI_ENDPOINT=<INSERT ENDPOINT URL HERE>
----
== Spring CLI
Download the latest https://github.com/spring-projects-experimental/spring-cli/releases[Spring CLI Release]
and follow the https://docs.spring.io/spring-cli/reference/installation.html#_setting_up_your_path_or_alias[instructions] to add `spring` to your `PATH`.
Create a simple AI application
* For OpenAI
```shell
spring boot new ai
```
or
* For Azure OpenAI
```shell
spring boot new ai-azure
```
You can also `ADD` the same simple AI application to your current project using
* For OpenAI
```shell
spring boot add ai
```
or
* For Azure OpenAI
```shell
spring boot add ai-azure
```
There is a project catalog available for Azure OpenAI that covers more functionality.
Add the catalog by running the command
* For Azure Open AI
```shell
spring project-catalog add ai-azure
```
Now you have the following projects that you can use to create a new project using the `spring boot new` command or add to your existing project using the `spring boot add` command.
```shell
spring project list
├──────────────────────────┼───────────────┼────────────────────────────────────────────────────────────────────┼────────┼───────────────┤
│ai-azure-hello-world │AI - Hello, │https://github.com/rd-1-2022/ai-azure-openai-helloworld │ai-azure│[java-17, │
│ │World │ │ │boot-3.1.x, ai,│
│ │ │ │ │azure, web] │
├──────────────────────────┼───────────────┼────────────────────────────────────────────────────────────────────┼────────┼───────────────┤
│ai-azure-prompt-templating│AI - Prompt │https://github.com/rd-1-2022/ai-azure-prompt-template │ai-azure│[java-17, │
│ │Templating │ │ │boot-3.1.x, ai,│
│ │ │ │ │azure, prompt │
│ │ │ │ │templating] │
├──────────────────────────┼───────────────┼────────────────────────────────────────────────────────────────────┼────────┼───────────────┤
│ai-azure-prompt-roles │AI - Prompt │https://github.com/rd-1-2022/ai-azure-openai-prompt-roles │ai-azure│[java-17, │
│ │Templating │ │ │boot-3.1.x, ai,│
│ │ │ │ │azure, prompt │
│ │ │ │ │roles] │
├──────────────────────────┼───────────────┼────────────────────────────────────────────────────────────────────┼────────┼───────────────┤
│ai-azure-stuff-prompt │AI - Stuff the │https://github.com/rd-1-2022/ai-azure-stuff-prompt │ai-azure│[java-17, │
│ │prompt │ │ │boot-3.1.x, ai,│
│ │ │ │ │azure, prompt │
│ │ │ │ │stuff] │
├──────────────────────────┼───────────────┼────────────────────────────────────────────────────────────────────┼────────┼───────────────┤
│ai-azure-prompt-rag │AI - Retrieval │https://github.com/rd-1-2022/ai-azure-retrieval-augmented-generation│ai-azure│[java-17, │
│ │Augmented │ │ │boot-3.1.x, ai,│
│ │Generation │ │ │azure, │
│ │ │ │ │retrieval] │
└──────────────────────────┴───────────────┴────────────────────────────────────────────────────────────────────┴────────┴───────────────┘
```
== Sample Projects
You can clone these projects on GitHub to get started.

3
spring-ai-docs/src/main/antora/modules/ROOT/pages/prompt/index.adoc
View File

@@ -1,3 +0,0 @@
= Creating a Prompt
TBD