From dba217823d4e61efcb7b6d1963b97dc0d3e2af17 Mon Sep 17 00:00:00 2001 From: Eric Evans <194135482+ericevans-nv@users.noreply.github.com> Date: Tue, 22 Apr 2025 15:15:04 -0500 Subject: [PATCH 1/2] Updating HITL reference guide to instruct users to toggle ws mode and updating broken link. --- docs/source/guides/create-customize-workflows.md | 2 +- docs/source/references/interactive-models.md | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/guides/create-customize-workflows.md b/docs/source/guides/create-customize-workflows.md index 49d04e9f8..a49b88327 100644 --- a/docs/source/guides/create-customize-workflows.md +++ b/docs/source/guides/create-customize-workflows.md @@ -183,7 +183,7 @@ AgentIQ includes several built-in tools (functions) that can be used in any work aiq info components -t function ``` -The current workflow defines a tool to query the [LangSmith User Guide](https://docs.smith.langchain.com/user_guide). This is defined in the `tools` section of the configuration file: +The current workflow defines a tool to query the [LangSmith User Guide](https://docs.smith.langchain.com). This is defined in the `tools` section of the configuration file: ```yaml functions: webpage_query: diff --git a/docs/source/references/interactive-models.md b/docs/source/references/interactive-models.md index 1124d4063..2428b4ab1 100644 --- a/docs/source/references/interactive-models.md +++ b/docs/source/references/interactive-models.md @@ -19,7 +19,9 @@ limitations under the License. AgentIQ provides interactive prompt and response Pydantic data models as a way to validate, serialize, and document data structures to support human input during the execution of an agent workflow. **Note**: All human in the loop interaction data models are supported by the `aiq serve` command, while the `aiq run` -command **only** supports the {py:mod}`aiq.data_models.interactive.HumanPromptText` data model. +command **only** supports the {py:mod}`aiq.data_models.interactive.HumanPromptText` data model. Ensure WebSocket mode +is enabled by toggling the setting in the top-right corner of the webpage for proper interaction when using this feature +with the front-end user interface. ## How to Use Interactive Prompt and Response Data Models Start by acquiring an instance of the {class}`aiq.builder.user_interaction_manager.AIQUserInteractionManager` class From c0ff6d9c9a7a911c3dcc613bbb901dd99a14e0fb Mon Sep 17 00:00:00 2001 From: Eric Evans <194135482+ericevans-nv@users.noreply.github.com> Date: Tue, 22 Apr 2025 16:06:50 -0500 Subject: [PATCH 2/2] Updating all Lang Smith broken links --- docs/source/concepts/workflow-configuration.md | 2 +- docs/source/guides/create-customize-workflows.md | 8 ++++---- docs/source/guides/locally-hosted-llms.md | 4 ++-- .../locally_hosted_llms/nim_config.yml | 2 +- .../locally_hosted_llms/vllm_config.yml | 2 +- .../workflows/custom_workflow/custom_config.yml | 2 +- examples/simple/README.md | 2 +- examples/simple/src/aiq_simple/configs/config.yml | 2 +- examples/simple/src/aiq_simple/configs/eval_config.yml | 2 +- .../simple/src/aiq_simple/configs/eval_upload_config.yml | 2 +- 10 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/source/concepts/workflow-configuration.md b/docs/source/concepts/workflow-configuration.md index 0db1f900a..5e165617d 100644 --- a/docs/source/concepts/workflow-configuration.md +++ b/docs/source/concepts/workflow-configuration.md @@ -40,7 +40,7 @@ The workflow configuration file is a YAML file that specifies the tools and mode functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 chunk_size: 512 diff --git a/docs/source/guides/create-customize-workflows.md b/docs/source/guides/create-customize-workflows.md index a49b88327..192037af9 100644 --- a/docs/source/guides/create-customize-workflows.md +++ b/docs/source/guides/create-customize-workflows.md @@ -97,7 +97,7 @@ The workflow configuration file is a YAML file that specifies the tools and mode functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 chunk_size: 512 @@ -188,7 +188,7 @@ The current workflow defines a tool to query the [LangSmith User Guide](https:// functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 chunk_size: 512 @@ -212,7 +212,7 @@ To do this, create a copy of the original workflow configuration file. To add th functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 chunk_size: 512 @@ -223,7 +223,7 @@ to: functions: langsmith_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 chunk_size: 512 diff --git a/docs/source/guides/locally-hosted-llms.md b/docs/source/guides/locally-hosted-llms.md index 6105ec1a2..32df6791a 100644 --- a/docs/source/guides/locally-hosted-llms.md +++ b/docs/source/guides/locally-hosted-llms.md @@ -87,7 +87,7 @@ To define the pipeline configuration, we will start with the `examples/simple/co functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 chunk_size: 512 @@ -149,7 +149,7 @@ The pipeline configuration will be similar to the NIM example, with the key diff functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: vllm_embedder chunk_size: 512 diff --git a/examples/documentation_guides/locally_hosted_llms/nim_config.yml b/examples/documentation_guides/locally_hosted_llms/nim_config.yml index 602a57b28..ee6a3921d 100644 --- a/examples/documentation_guides/locally_hosted_llms/nim_config.yml +++ b/examples/documentation_guides/locally_hosted_llms/nim_config.yml @@ -16,7 +16,7 @@ functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 chunk_size: 512 diff --git a/examples/documentation_guides/locally_hosted_llms/vllm_config.yml b/examples/documentation_guides/locally_hosted_llms/vllm_config.yml index 9c8a01919..541205692 100644 --- a/examples/documentation_guides/locally_hosted_llms/vllm_config.yml +++ b/examples/documentation_guides/locally_hosted_llms/vllm_config.yml @@ -16,7 +16,7 @@ functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: vllm_embedder chunk_size: 512 diff --git a/examples/documentation_guides/workflows/custom_workflow/custom_config.yml b/examples/documentation_guides/workflows/custom_workflow/custom_config.yml index 3616eabe1..01a337161 100644 --- a/examples/documentation_guides/workflows/custom_workflow/custom_config.yml +++ b/examples/documentation_guides/workflows/custom_workflow/custom_config.yml @@ -16,7 +16,7 @@ functions: langsmith_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 chunk_size: 512 diff --git a/examples/simple/README.md b/examples/simple/README.md index bc8c074e2..e73379e63 100644 --- a/examples/simple/README.md +++ b/examples/simple/README.md @@ -70,7 +70,7 @@ aiq run --config_file examples/simple/configs/config.yml --input "What is LangSm $ aiq run --config_file=examples/simple/configs/config.yml --input "What is LangSmith" 2025-01-29 15:33:57,665 - aiq.cli.run - INFO - Loading configuration from: examples/simple/configs/config.yml 2025-01-29 15:33:59,375 - langchain_community.utils.user_agent - WARNING - USER_AGENT environment variable not set, consider setting it to identify your requests. -2025-01-29 15:33:59,410 - aiq_simple.register - INFO - Generating docs for the webpage: https://docs.smith.langchain.com/user_guide +2025-01-29 15:33:59,410 - aiq_simple.register - INFO - Generating docs for the webpage: https://docs.smith.langchain.com 2025-01-29 15:34:00,725 - faiss.loader - INFO - Loading faiss. 2025-01-29 15:34:00,816 - faiss.loader - INFO - Successfully loaded faiss. 2025-01-29 15:34:01,255 - aiq.workflows.react_agent.agent - INFO - Initializing ReAct Agent Graph diff --git a/examples/simple/src/aiq_simple/configs/config.yml b/examples/simple/src/aiq_simple/configs/config.yml index 8bb909d13..10a101849 100644 --- a/examples/simple/src/aiq_simple/configs/config.yml +++ b/examples/simple/src/aiq_simple/configs/config.yml @@ -16,7 +16,7 @@ functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 chunk_size: 512 diff --git a/examples/simple/src/aiq_simple/configs/eval_config.yml b/examples/simple/src/aiq_simple/configs/eval_config.yml index 93f3f59f8..2898b5263 100644 --- a/examples/simple/src/aiq_simple/configs/eval_config.yml +++ b/examples/simple/src/aiq_simple/configs/eval_config.yml @@ -20,7 +20,7 @@ general: functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 current_datetime: diff --git a/examples/simple/src/aiq_simple/configs/eval_upload_config.yml b/examples/simple/src/aiq_simple/configs/eval_upload_config.yml index 3979eeecc..0411c4e64 100644 --- a/examples/simple/src/aiq_simple/configs/eval_upload_config.yml +++ b/examples/simple/src/aiq_simple/configs/eval_upload_config.yml @@ -25,7 +25,7 @@ general: functions: webpage_query: _type: webpage_query - webpage_url: https://docs.smith.langchain.com/user_guide + webpage_url: https://docs.smith.langchain.com description: "Search for information about LangSmith. For any questions about LangSmith, you must use this tool!" embedder_name: nv-embedqa-e5-v5 current_datetime: