Skip to content

Updating HITL reference guide to instruct users to toggle ws mode and… #142

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 22, 2025
Merged

Updating HITL reference guide to instruct users to toggle ws mode and… #142

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dba2178
Updating HITL reference guide to instruct users to toggle ws mode and…
ericevans-nv Apr 22, 2025
c0ff6d9
Updating all Lang Smith broken links
ericevans-nv Apr 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/concepts/workflow-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions docs/source/guides/create-customize-workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -183,12 +183,12 @@ 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:
_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
Expand All @@ -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
Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/guides/locally-hosted-llms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion docs/source/references/interactive-models.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/documentation_guides/locally_hosted_llms/nim_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/documentation_guides/locally_hosted_llms/vllm_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/documentation_guides/workflows/custom_workflow/custom_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/simple/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/simple/src/aiq_simple/configs/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/simple/src/aiq_simple/configs/eval_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion examples/simple/src/aiq_simple/configs/eval_upload_config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading