From a97976e4341e75f80888aa9655721219b3a711ba Mon Sep 17 00:00:00 2001 From: John Blum Date: Fri, 3 Nov 2023 06:46:39 -0700 Subject: [PATCH] Clean up grammatical errors and misspellings in the reference documentation. (#77) * Fixes misspelling in concepts.adco, 'Prompts' section. * Uses plural form of AI Models in aiclient.adoc. * Fixes several grammatical mistakes in vectordbs.adoc. --- .../src/main/antora/modules/ROOT/pages/api/aiclient.adoc | 2 +- .../src/main/antora/modules/ROOT/pages/api/vectordbs.adoc | 2 +- spring-ai-docs/src/main/antora/modules/ROOT/pages/concepts.adoc | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/aiclient.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/aiclient.adoc index 580ebeec1..e616bfad7 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/aiclient.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/aiclient.adoc @@ -40,4 +40,4 @@ Planned implementations Others are welcome, the list is not at all closed. -Note, there are several AI Model that are *not* OpenAI provided models, but expose an OpenAI compatible API. +Note, there are several AI Models that are *not* OpenAI provided models, but expose an OpenAI compatible API. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs.adoc index f7eeb58bc..162370e42 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/vectordbs.adoc @@ -6,7 +6,7 @@ Vector Databases are a specialized type of database that plays an essential role In Vector Databases, queries differ from traditional relational databases. Instead of exact matches, they perform similarity searches. When given a vector as a query, a Vector Database returns vectors that are "similar" to the query vector. -Further details on how this similarity is calculated at a high level in provided in a later section. +Further details on how this similarity is calculated at a high-level is provided in a later section. Vector Databases are used to integrate your data with AI Models. The first step in their usage is to load your data into a Vector Database. diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/concepts.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/concepts.adoc index 4c5217406..ae61940a7 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/concepts.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/concepts.adoc @@ -55,7 +55,7 @@ However, it encompasses much more than that. In many AI Models, the text for the prompt is not just a simple String. ChatGPT's API has multiple text inputs within a prompt, with each text input being assigned a role. -For example, there is the system role, that instructs the model how ot behave and sets the context for the interaction. +For example, there is the system role, that instructs the model how to behave and sets the context for the interaction. There is also the user role, which is typically the input from the user. Crafting effective prompts is both an art and a science.