Skip to content

Commit

Permalink
Update documentation: ui.mdx) to use -x-, and llms.mdx to correct mod…
Browse files Browse the repository at this point in the history
…els hyperlink. Remove redundant () in settings.py.
  • Loading branch information
aly-shehata committed Dec 10, 2023
1 parent ce199e9 commit 26dbbe4
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion fern/docs/pages/manual/llms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ llm:
openai:
api_key: <your_openai_api_key> # You could skip this configuration and use the OPENAI_API_KEY env var instead
model: <openai_model_to_use> # Optional model to use. Default is "gpt-3.5-turbo"
# Note: Open AI Models are listed here [here](https://platform.openai.com/docs/models)
# Note: Open AI Models are listed here: https://platform.openai.com/docs/models
```

And run PrivateGPT loading that profile you just created:
Expand Down
8 changes: 4 additions & 4 deletions fern/docs/pages/manual/ui.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ you have given the model. Examples of system prompts can be be found

Some interesting examples to try include:

* You are {x}. You have all the knowledge and personality of {x}. Answer as if you were {x} using
* You are -X-. You have all the knowledge and personality of -X-. Answer as if you were -X- using
their manner of speaking and vocabulary.
* Example: You are Shakespeare. You have all the knowledge and personality of Shakespeare.
Answer as if you were Shakespeare using their manner of speaking and vocabulary.
* You are an expert (at) {role}. Answer all questions using your expertise on {specific domain topic}.
* You are an expert (at) -role-. Answer all questions using your expertise on -specific domain topic-.
* Example: You are an expert software engineer. Answer all questions using your expertise on Python.
* You are a {role} bot, respond with {response criteria} needed. If no {response criteria} is needed,
respond with {alternate response}
* You are a -role- bot, respond with -response criteria needed-. If no -response criteria- is needed,
respond with -alternate response-.
* Example: You are a grammar checking bot, respond with any grammatical corrections needed. If no corrections
are needed, respond with "verified".
4 changes: 2 additions & 2 deletions private_gpt/settings/settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ class OpenAISettings(BaseModel):
api_key: str
model: str = Field(
"gpt-3.5-turbo",
description=("OpenAI Model to use. Example: 'gpt-4'."),
description="OpenAI Model to use. Example: 'gpt-4'.",
)


Expand All @@ -156,7 +156,7 @@ class UISettings(BaseModel):
path: str
default_chat_system_prompt: str = Field(
None,
description=("The default system prompt to use for the chat mode."),
description="The default system prompt to use for the chat mode.",
)
default_query_system_prompt: str = Field(
None, description="The default system prompt to use for the query mode."
Expand Down

0 comments on commit 26dbbe4

Please sign in to comment.