Skip to content

Commit

Permalink
LK CHM Docs review #12 - Cerebral doc - appx.
Browse files Browse the repository at this point in the history
  • Loading branch information
likamrat committed Nov 15, 2024
1 parent 839f940 commit d12e1fb
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 22 deletions.
12 changes: 6 additions & 6 deletions docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Note that the examples and screenshots shown in this documentation are for illus
- Specific store configuration
- Updated procedures and documentation

> **Note**: For additional prompt examples, please refer to the [Prompt examples](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#prompt-examples) section in the Jumpstart Cerebral appendix file.
> **Note**: For additional prompt examples, please refer to the ["Prompt examples"](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#prompt-examples) section in the Jumpstart Cerebral appendix file.
Based on your query, Cerebral automatically classifies the type of request and routes it to the appropriate system (documentation, real-time data, or business intelligence) to provide relevant and contextual responses. For demonstration purposes, users can enable the "Debug" checkbox in the interface to view behind-the-scenes details such as:

Expand Down Expand Up @@ -123,7 +123,7 @@ The system orchestrates three specialized databases, each optimized for specific
- Tracks operational status
- Stores historical trending data

> **Note**: For additional details, please refer to the [MQTT simulated equipment metrics](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#mqtt-simulated-equipment-metrics) section in the Jumpstart Cerebral appendix file.
> **Note**: For additional details, please refer to the ["MQTT simulated equipment metrics"](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#mqtt-simulated-equipment-metrics) section in the Jumpstart Cerebral appendix file.
- **SQL Server** handles all commercial operations data, providing a robust foundation for business intelligence. From transaction processing to inventory management, this relational database ensures accurate tracking of sales patterns, stock levels, and customer interactions, enabling data-driven decision making across the organization.

Expand All @@ -132,7 +132,7 @@ The system orchestrates three specialized databases, each optimized for specific
- Stores customer data
- Handles business intelligence queries

> **Note**: For additional details on the relational database structure and how it is used by Contoso Hypermarket for commercial and operational needs, please refer to the [Relational database structure](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#relational-database-structure) section in the Jumpstart Cerebral appendix file.
> **Note**: For additional details on the relational database structure and how it is used by Contoso Hypermarket for commercial and operational needs, please refer to the ["Relational database structure"](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#relational-database-structure) section in the Jumpstart Cerebral appendix file.
- **Chroma Vector Database** serves as the foundation for Cerebral's documentation intelligence. By indexing technical manuals, maintenance procedures, and operational guides, it enables sophisticated semantic search capabilities through Retrieval Augmented Generation (RAG). This allows Cerebral to understand the context and intent behind documentation queries, delivering precise and relevant information to users.

Expand All @@ -145,7 +145,7 @@ The system orchestrates three specialized databases, each optimized for specific

All technical documentation is automatically indexed and processed by Cerebral's RAG system, enabling natural language queries about any aspect of these systems. Instead of manually searching through PDFs, users can simply ask Cerebral specific questions about equipment operation, maintenance procedures, or troubleshooting steps.

> **Note**: For a list of the various technical manuals used by Contoso Hypermarket for operational needs, please refer to the [Available technical manuals](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#Available-technical-manuals) section in the Jumpstart Cerebral appendix file.
> **Note**: For a list of the various technical manuals used by Contoso Hypermarket for operational needs, please refer to the ["Available technical manuals"](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#Available-technical-manuals) section in the Jumpstart Cerebral appendix file.
#### Intelligent query routing

Expand All @@ -161,13 +161,13 @@ While Cerebral is currently showcased within Contoso Hypermarket's retail enviro

Cerebral is design to support various roles and industry, for example, an Inventory Manager in the retail industry, how cares about monitoring the store stock levels.

> **Note**: For additional details on the the various industries and roles supported by Cerebral, please refer to the [Industry and Role support](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#Industry-and-Role-support) section in the Jumpstart Cerebral appendix file.
> **Note**: For additional details on the the various industries and roles supported by Cerebral, please refer to the ["Industry and Role support"](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#Industry-and-Role-support) section in the Jumpstart Cerebral appendix file.
### Example prompts by category

Cerebral understands variations in phrasing and can maintain context through follow-up prompts. For example, in the "Documentation and Procedures" category, a prompt such _"What are the steps to close the store at the end of the day?"_ will lead to a step-by-step procedure with checklist. For more information about data sources and query processing, see the [Unified Data Sources](#unified-data-sources) section.

> **Note**: For additional examples of common prompts Cerebral can handle, please refer to the [Examples of common prompts Cerebral can handle](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#Examples-of-common-prompts-Cerebral-can-handle) section in the Jumpstart Cerebral appendix file.
> **Note**: For additional examples of common prompts Cerebral can handle, please refer to the ["Common prompts Cerebral can handle"](https://github.com/fcabrera23/arc_jumpstart_docs/blob/canary/docs/azure_jumpstart_ag/contoso_hypermarket/cerebral/cerebral_appendix.md#Common-prompts-Cerebral-can-handle) section in the Jumpstart Cerebral appendix file.
>
### Prompt catalog system
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,22 +62,22 @@ The following table details the current supported industries and roles by Cerebr
| Automotive | - Line Supervisor<br>- Quality Inspector<br>- Maintenance Technician | - Assembly line monitoring<br>- Quality assurance checks<br>- Equipment maintenance |
| Hypermarket | - Store Manager<br>- Shopper<br>- Maintenance Worker | - Sales analytics<br>- Product location<br>- Facility maintenance |

## Examples of common prompts Cerebral can handle
## Common prompts Cerebral can handle

| Category | Prompt Example | Expected Response Type |
|----------|--------------|----------------------|
| Documentation & Procedures | 1. "What are the steps to close the store at the end of the day?" | Step-by-step procedure with checklist |
| Documentation & Procedures | 2. "How do I perform the daily cleaning routine for the meat department?" | Detailed cleaning protocol with safety guidelines |
| Documentation & Procedures | 3. "What's the emergency shutdown procedure for the refrigeration system?" | Emergency procedure with critical steps highlighted |
| Documentation & Procedures | 4. "Show me the maintenance checklist for the automated checkout machines" | Maintenance checklist with technical specifications |
| Documentation & Procedures | 5. "What are the safety protocols for handling spills in the produce area?" | Safety guidelines and cleaning procedures |
| Real-time Operations | 1. "What's the current capacity of all automated checkouts in use?" | Real-time usage metrics and availability status |
| Real-time Operations | 2. "Show me the temperature trends for all refrigeration units in the last hour" | Temperature graphs and anomaly indicators |
| Real-time Operations | 3. "Are any SmartShelves reporting low stock alerts right now?" | Current stock alerts and locations |
| Real-time Operations | 4. "What's the average wait time at the deli counter currently?" | Current wait times and historical comparison |
| Real-time Operations | 5. "How is HVAC-02 performing compared to its normal baseline?" | Performance metrics with baseline comparison |
| Commercial Data | 1. "Which products in the dairy section need restocking?" | List of products below threshold with quantities |
| Commercial Data | 2. "What was our busiest hour for sales yesterday?" | Sales volume analysis with peak times |
| Commercial Data | 3. "Show me the performance of our seasonal products this month" | Sales trends and inventory analysis |
| Commercial Data | 4. "What's the current inventory level for fresh produce?" | Current stock levels with reorder recommendations |
| Commercial Data | 5. "Which payment method was most used in the last week?" | Payment method breakdown with percentages |
| Documentation and Procedures | _"What are the steps to close the store at the end of the day?"_ | Step-by-step procedure with checklist |
|| _"How do I perform the daily cleaning routine for the meat department?"_ | Detailed cleaning protocol with safety guidelines |
|| _"What's the emergency shutdown procedure for the refrigeration system?"_ | Emergency procedure with critical steps highlighted |
|| _"Show me the maintenance checklist for the automated checkout machines"_ | Maintenance checklist with technical specifications |
|| _"What are the safety protocols for handling spills in the produce area?"_ | Safety guidelines and cleaning procedures |
| Real-time Operations | _"What's the current capacity of all automated checkouts in use?"_ | Real-time usage metrics and availability status |
|| _"Show me the temperature trends for all refrigeration units in the last hour"_ | Temperature graphs and anomaly indicators |
|| _"Are any SmartShelves reporting low stock alerts right now?"_ | Current stock alerts and locations |
|| _"What's the average wait time at the deli counter currently?"_ | Current wait times and historical comparison |
|| _"How is HVAC-02 performing compared to its normal baseline?"_ | Performance metrics with baseline comparison |
| Commercial Data | "Which products in the dairy section need restocking?"_ | List of products below threshold with quantities |
|| _"What was our busiest hour for sales yesterday?"_ | Sales volume analysis with peak times |
|| _"Show me the performance of our seasonal products this month"_ | Sales trends and inventory analysis |
|| _"What's the current inventory level for fresh produce?"_ | Current stock levels with reorder recommendations |
|| _"Which payment method was most used in the last week?"_ | Payment method breakdown with percentages |

0 comments on commit d12e1fb

Please sign in to comment.