From 1ac86817e4f4e84a5e7eddd504d716d0fd10f56b Mon Sep 17 00:00:00 2001 From: Palaniappan R Date: Sat, 1 Feb 2025 03:19:20 +0530 Subject: [PATCH] ora: update readme Signed-off-by: Palaniappan R --- src/ora/README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/src/ora/README.md b/src/ora/README.md index 83f4b10ef6e..c5bc9fc8c8b 100644 --- a/src/ora/README.md +++ b/src/ora/README.md @@ -1,19 +1,24 @@ # ORAssistant -The OpenROAD chat assistant aims to provide easy and quick access to information regarding tools, responses to questions and commonly occurring problems in OpenROAD and its native flow OpenROAD-flow-scripts. The current architecture uses certain retrieval techniques on OpenROAD documentation and other online data sources. - -## Commands +ORAssistant is a chat assistant designed to provide quick and easy access to information about OpenROAD tools, answer questions, and address common issues related to OpenROAD and its native flow, OpenROAD-flow-scripts. The system leverages retrieval techniques on OpenROAD documentation and other online data sources to deliver accurate and relevant responses. +Commands ### ora_init -The `ora_init` command sets up user consent for using the ORAssistant and configures the host URL if a local version is preferred. - -#### Parameter +The ora_init command is used to configure user consent and set up the host URL for ORAssistant. It supports both cloud-hosted and local versions of the tool. -`consent`: Indicates whether the user agrees to use the web-hosted version. Accepts values like "y" (yes) or "n" (no). +Cloud-hosted version: + To use the cloud-hosted version and provide consent, run: `ora_init cloud y` + To revoke consent and stop using the cloud-hosted version, run: `ora_init cloud n` -`hostUrl` (optional): The URL of the local ORAssistant host if the web-hosted version is declined. +Local version: + To use a locally hosted version of ORAssistant, run: `ora_init local hostUrl` + Replace hostUrl with the backend URL of your locally hosted ORAssistant. For more details on setting up a local backend, visit https://github.com/The-OpenROAD-Project/ORAssistant/ ### askbot -The `askbot` commands accepts a user query, optionally lists sources (-listSources flag), and sends the query as a POST request to the ORAssistant's host URL. \ No newline at end of file +The askbot command allows users to submit queries to ORAssistant. It supports an optional `-listSources` flag to display the sources of information used in the response. The query is sent as a POST request to the configured ORAssistant host URL. + +Example usage: `askbot "How do I resolve timing violations in OpenROAD?" -listSources` + +This command sends the query to ORAssistant and, if the -listSources flag is included, lists the sources used to generate the response.