Docs branch - v1 of our tech docs (#69)

* added the first set of docs for our technical docs

* more docuemtnation changes

* added support for prompt processing and updated life of a request

* updated docs to including getting help sections and updated life of a request

* committing local changes for getting started guide, sample applications, and full reference spec for prompt-config

* updated configuration reference, added sample app skeleton, updated favico

* fixed the configuration refernce file, and made minor changes to the intent detection. commit v1 for now

---------

Co-authored-by: Salman Paracha <salmanparacha@MacBook-Pro-261.local>
Co-authored-by: Adil Hafeez <adil@katanemo.com>
This commit is contained in:
Salman Paracha 2024-09-20 17:08:42 -07:00 committed by GitHub
parent 233976a568
commit 80c554ce1a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
34 changed files with 1040 additions and 0 deletions

View file

@ -0,0 +1,39 @@
version: "0.1-beta"
listen:
address: 127.0.0.1 | 0.0.0.0
port_value: 8080 #If you configure port 443, you'll need to update the listener to with your tls_certificates
messages: tuple | hugging-face-messages-api
system_prompts:
- name: network_assistant
content: you are a network assistant that just offers facts; not advice on manufacturers or purchasing decisions
llm_providers:
- name: "OpenAI"
access_key: $OPEN_AI_KEY
model: gpt-4
default: true
- name: "Mistral"
access_key: $MISTRAL_KEY
model: "mixtral8-7B"
prompt_endpoints:
- "http://127.0.0.2"
- "http://127.0.0.1"
prompt_guards:
input-guard:
- name: #jailbreak
on-exception-message: Looks like you are curious about my abilities. But I can only
prompt_targets:
- name: information_extraction
type: RAG
description: this prompt handles all information extractions scenarios
path: /agent/summary
- name: reboot_network_device
path: /agent/action
description: used to help network operators with perform device operations like rebooting a device.
parameters:
error_target: #handle errors from Bolt or upstream LLMs
name: “error_handler”
path: /errors