From 9ee08ad5ed6ac654e13eff6b4dab28d615fcba9e Mon Sep 17 00:00:00 2001 From: niltonheck Date: Wed, 16 Oct 2024 13:54:41 -0300 Subject: [PATCH] chore: add system prompt intro --- packages/docs/config/menu/orama-cloud.ts | 4 ++++ .../docs/cloud/custom-system-prompts/index.mdx | 15 +++++++++++++++ 2 files changed, 19 insertions(+) create mode 100644 packages/docs/src/content/docs/cloud/custom-system-prompts/index.mdx diff --git a/packages/docs/config/menu/orama-cloud.ts b/packages/docs/config/menu/orama-cloud.ts index 8a243e154..b06d0ed68 100644 --- a/packages/docs/config/menu/orama-cloud.ts +++ b/packages/docs/config/menu/orama-cloud.ts @@ -86,6 +86,10 @@ const oramaCloudMenu = [ label: 'Custom system prompts', collapsed: true, items: [ + { + label: 'Introduction to Custom System Prompts', + link: '/cloud/custom-system-prompts/' + }, { label: 'Customizing the system prompts', link: '/cloud/custom-system-prompts/customizing-the-system-prompts' diff --git a/packages/docs/src/content/docs/cloud/custom-system-prompts/index.mdx b/packages/docs/src/content/docs/cloud/custom-system-prompts/index.mdx new file mode 100644 index 000000000..77763efb2 --- /dev/null +++ b/packages/docs/src/content/docs/cloud/custom-system-prompts/index.mdx @@ -0,0 +1,15 @@ +--- +title: Custom System Prompts +description: Custom System Prompts let you customize AI behavior with tailored instructions, ensuring safe, precise, and efficient responses. +editUrl: false +--- + +Custom System Prompts in Orama allow you to define custom instructions that shape how the AI engine responds to users. These prompts can be tailored for various use cases, such as altering the tone of the AI, introducing information that isn’t in the data sources, or directing users toward specific actions. + +For example, if a user asks about pricing, a system prompt could instruct the AI to suggest visiting a website for details instead of providing a direct answer. You could also include context like software versions or other specialized information to ensure more accurate responses. The flexibility of System Prompts enables you to mold the assistant’s behavior to meet your specific needs. + +## Best Practices and Limitations + +While System Prompts give you powerful control over the AI’s behavior, they are subject to certain validation rules to maintain safety and efficiency. Orama has implemented jailbreak protection to guard against malicious or harmful actions. There are also limits on the length and complexity of prompts to ensure optimal performance. + +These safeguards ensure that while you have the freedom to shape the AI’s responses, the assistant will always behave in a reliable, secure, and efficient manner. \ No newline at end of file