Skip to content

Commit

Permalink
Clean up grammatical errors and misspellings in the reference documen…
Browse files Browse the repository at this point in the history
…tation. (#77)

* Fixes misspelling in concepts.adco, 'Prompts' section.
* Uses plural form of AI Models in aiclient.adoc.
* Fixes several grammatical mistakes in vectordbs.adoc.
  • Loading branch information
jxblum authored Nov 3, 2023
1 parent be10cc4 commit a97976e
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit a97976e

Please sign in to comment.