ibm-watsonx-gov 1.3.3__cp313-cp313-macosx_11_0_arm64.whl

ibm_watsonx_gov/tools/onboarding/create/answer_relevance_detector.json

@@ -0,0 +1,57 @@
+{
+    "display_name": "Answer Relevance Detector",
+    "tool_name": "answer_relevance_detector",
+    "service_provider_type": "IBM",
+    "description": "Tool that detects whether the generated text meaningfully and directly addresses the user's input.",
+    "summary":"Tool that detects whether the generated text meaningfully and directly addresses the user’s input. It checks if the response provides clear, accurate, and complete information that aligns with the intent of the query, while avoiding unnecessary or ambiguous content. This helps ensure that the final output is useful, contextually appropriate, and aligned with the user’s expectations.",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": ["RAG"],
+    "framework": ["langchain","langgraph"],
+    "code": {
+        "source_code_url": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "config":{
+            "properties": {
+              "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float",
+                "default":0.7
+              }
+            },
+            "type": "object"
+    },
+    "schema":{
+        "properties": {
+            "input": {
+                "description": "Input text",
+                "title": "Input",
+                "type": "string"
+            },
+            "generated_text": {
+                "description": "Response from LLM",
+                "title": "Generated Text",
+                "type": "string"
+            },
+            "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float"
+            }
+        },
+        "required": [
+          "input", "generated_text"
+        ],
+        "title": "AnswerRelevanceDetectorInput",
+        "type": "object"
+    },
+    "environment_variables": [
+        "WXG_SERVICE_INSTANCE_ID","WATSONX_REGION"
+    ],
+    "regions": ["ys1dev","ypqa","us-south","eu-de","ca-tor","au-syd","eu-gb"],
+    "cpd_supported": "false"
+}

ibm_watsonx_gov/tools/onboarding/create/chromadb_retrieval_tool.json

@@ -0,0 +1,63 @@
+{
+    "display_name": "Chroma Vector DB",
+    "tool_name": "chromadb_retrieval_tool",
+    "service_provider_type": "IBM",
+    "description": "Query the Chroma vector store and return the results",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": ["Other"],
+    "framework": ["langchain","langgraph"],
+    "code": {
+        "source_code_base64": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "config":{
+            "description": "Configuration schema for ChromaDB Vector search tools",
+            "properties": {
+              "path": {               
+                "description": "Path to the database",
+                "type": "string"
+              },
+              "collection_name": {                    
+                "description": "Name of the collection where documents are stored",
+                "type": "string"
+              },
+              "embedding_function": {                    
+                "description": "Function to use for embedded documents",
+                "type": "EmbeddingFunction"
+              },
+              "n_results": {   
+                "default": 3,                  
+                "description": "Optional number of results to return",
+                "type": "integer"
+              }
+            },
+            "required": [
+                "path",
+                "collection_name",
+                "embedding_function"
+            ],
+            "title": "ChromadbSearchConfig",
+            "type": "object"
+    },
+    "schema":{
+        "properties": {
+          "query": {
+            "description": "Search chromadb vector store for a given input",
+            "title": "Query",
+            "type": "string"
+          }
+        },
+        "required": [
+          "query"
+        ],
+        "title": "RetrievalToolInput",
+        "type": "object"
+    },
+    "dependencies": {
+        "remote_services":[],
+        "run_time_packages":["chromadb"]
+    }
+}

ibm_watsonx_gov/tools/onboarding/create/context_relevance_detector.json

@@ -0,0 +1,57 @@
+{
+    "display_name": "Context Relevance Detector",
+    "tool_name": "context_relevance_detector",
+    "service_provider_type": "IBM",
+    "description": "Tool that detects whether the user input is relevant to the given context.",
+    "summary":"Tool that detects whether a user’s input is relevant to the provided context. It compares the query against the retrieved knowledge or reference material to determine alignment. This helps ensure that responses are grounded in the intended domain and prevents the use of unrelated or misleading information.",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": ["RAG"],
+    "framework": ["langchain","langgraph"],
+    "code": {
+        "source_code_url": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "config":{
+            "properties": {
+              "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float",
+                "default":0.7
+              }
+            },
+            "type": "object"
+    },
+    "schema":{
+        "properties": {
+            "input": {
+                "description": "Input text",
+                "title": "Input",
+                "type": "string"
+            },
+            "context": {
+                "description": "The retrieved or provided context to validate",
+                "title": "Context",
+                "type": "string"
+            },
+            "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float"
+            }
+        },
+        "required": [
+          "input", "context"
+        ],
+        "title": "ContextRelevanceDetectorInput",
+        "type": "object"
+    },
+    "environment_variables": [
+        "WXG_SERVICE_INSTANCE_ID","WATSONX_REGION"
+    ],
+    "regions": ["ys1dev","ypqa","us-south","eu-de","ca-tor","au-syd","eu-gb"],
+    "cpd_supported": "false"
+}

ibm_watsonx_gov/tools/onboarding/create/duduckgo_search_tool.json

@@ -0,0 +1,53 @@
+{
+    "display_name": "DuckDuckGo Search",
+    "tool_name": "duckduckgo_search_tool",
+    "service_provider_type": "IBM",
+    "description": "Use DuckDuckGoSearch and return results for given query",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": ["Search"],
+    "framework": ["langchain","langgraph"],
+    "code": {
+        "source_code_base64": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "config":{
+            "description": "Configuration schema for OOTB search tools",
+            "properties": {
+              "top_k_results": {
+                "default": 3,
+                "description": "Number of search results to retrieve",
+                "title": "Top K Results",
+                "type": "integer"
+              }
+            },
+            "title": "SearchToolConfig",
+            "type": "object"
+    },
+    "schema":{
+        "properties": {
+          "query": {
+            "description": "Search the input from the given search tool",
+            "title": "Query",
+            "type": "string"
+          },
+          "top_k_results": {
+            "default": 3,
+            "description": "Number of search results to retrieve",
+            "title": "Top K Results",
+            "type": "integer"
+          }
+        },
+        "required": [
+          "query"
+        ],
+        "title": "SearchToolInput",
+        "type": "object"
+    },
+  "dependencies": {
+        "remote_services":[],
+        "run_time_packages": []
+    }
+}

ibm_watsonx_gov/tools/onboarding/create/google_search_tool.json

@@ -0,0 +1,62 @@
+{
+    "display_name": "Google Search",
+    "tool_name": "google_search_tool",
+    "service_provider_type": "IBM",
+    "description": "Use GoogleSearch and return results for given query",
+    "inventory_id": "<attribute_value>",
+    "version": "1.1.0",
+    "reusable": "true",
+    "category": ["Search"],
+    "framework": ["langchain","langgraph"],
+    "code": {
+        "source_code_base64": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "config":{
+            "description": "Configuration schema for OOTB search tools",
+            "properties": {
+              "top_k_results": {
+                "default": 3,
+                "description": "Number of search results to retrieve",
+                "title": "Top K Results",
+                "type": "integer"
+              },
+              "serpapi_key": {
+                "description": "API key used to authenticate requests to SerpAPI. You can generate your API key from https://serpapi.com/manage-api-key.",
+                "title": "SerpAPI Key",
+                "type": "string"
+              }
+            },
+            "title": "SearchToolConfig",
+            "type": "object",
+            "required": [
+              "serpapi_key"
+            ]
+    },
+    "schema":{
+        "properties": {
+          "query": {
+            "description": "Search the input from the given search tool",
+            "title": "Query",
+            "type": "string"
+          },
+          "top_k_results": {
+            "default": 3,
+            "description": "Number of search results to retrieve",
+            "title": "Top K Results",
+            "type": "integer"
+          }
+        },
+        "required": [
+          "query"
+        ],
+        "title": "SearchToolInput",
+        "type": "object"
+    },
+  "dependencies": {
+        "remote_services":[],
+        "run_time_packages":["google-search-results"]
+    }
+}

ibm_watsonx_gov/tools/onboarding/create/hap_detector.json

@@ -0,0 +1,70 @@
+{
+    "display_name": "HAP Detector",
+    "tool_name": "hap_detector",
+    "service_provider_type": "IBM",
+    "description": "Tool to detect Hate, Abuse and Profanity content in text",
+    "summary":"Tool that detects hate speech, abusive language, and profanity in user input. It evaluates the text for harmful, offensive, or derogatory expressions that may target individuals or groups based on characteristics such as race, gender, religion, or other personal attributes. The tool helps maintain a respectful and professional environment by preventing the propagation of toxic or unsafe language in interactions.",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": [
+        "Guardrails"
+    ],
+    "framework": [
+        "langchain",
+        "langgraph"
+    ],
+    "code": {
+        "source_code_url": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "config": {
+        "properties": {
+            "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float",
+                "default":0.8
+            },
+            "title": "HAPConfig",
+            "type": "object"
+        }
+    },
+    "schema": {
+        "properties": {
+            "input": {
+                "description": "Input text",
+                "title": "Input",
+                "type": "string"
+            },
+            "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float"
+            }
+        },
+        "required": [
+            "input"
+        ],
+        "title": "HAPInput",
+        "type": "object"
+    },
+    "environment_variables": [
+        "WXG_SERVICE_INSTANCE_ID",
+        "WATSONX_REGION"
+    ],
+    "regions": [
+        "ys1dev",
+        "ypqa",
+        "mcspdev",
+        "mcspqa",
+        "us-south",
+        "eu-de",
+        "ca-tor",
+        "au-syd",
+        "jp-tok",
+        "eu-gb"
+    ],
+    "cpd_supported": "true"
+}

ibm_watsonx_gov/tools/onboarding/create/jailbreak_detector.json

@@ -0,0 +1,70 @@
+{
+    "display_name": "JailBreak Detector",
+    "tool_name": "jailbreak_detector",
+    "service_provider_type": "IBM",
+    "description": "Tool that detects jailbreak attempts in an input prompt.",
+    "summary": "Tool that detects jailbreak attempts within input prompts. Jailbreaks are a type of prompt injection designed to bypass safeguards, override restrictions, or manipulate system behavior. Detecting them ensures interactions remain safe, compliant, and aligned with intended use.",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": [
+        "Guardrails"
+    ],
+    "framework": [
+        "langchain",
+        "langgraph"
+    ],
+    "code": {
+        "source_code_url": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "config":{
+            "properties": {
+              "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float",
+                "default": 0.8
+            }
+        },
+        "title": "JailBreakConfig",
+        "type": "object"
+    },
+    "schema": {
+        "properties": {
+            "input": {
+                "description": "Input text",
+                "title": "Input",
+                "type": "string"
+            },
+            "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float"
+            }
+        },
+        "required": [
+            "input"
+        ],
+        "title": "JailBreakInput",
+        "type": "object"
+    },
+    "environment_variables": [
+        "WXG_SERVICE_INSTANCE_ID",
+        "WATSONX_REGION"
+    ],
+    "regions": [
+        "ys1dev",
+        "ypqa",
+        "mcspdev",
+        "mcspqa",
+        "us-south",
+        "eu-de",
+        "ca-tor",
+        "au-syd",
+        "jp-tok",
+        "eu-gb"
+    ],
+    "cpd_supported": "true"
+}

ibm_watsonx_gov/tools/onboarding/create/pii_detector.json

@@ -0,0 +1,36 @@
+{
+    "display_name": "PII Detector",
+    "tool_name": "pii_detector",
+    "service_provider_type": "IBM",
+    "description": "Tool that detects Personally Identifiable Information(PII) information in the input string.",
+    "summary":"Tool that detects Personally Identifiable Information (PII) in user input. It analyzes the text to identify sensitive details such as names, addresses, phone numbers, email addresses, etc. The purpose of the tool is to ensure privacy and compliance by recognizing and handling information that could reveal an individual’s identity.",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": ["Guardrails"], 
+    "framework": ["langchain","langgraph"],
+    "code": {
+        "source_code_url": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "schema":{
+        "properties": {
+            "input": {
+                "description": "Input text",
+                "title": "Input",
+                "type": "string"
+            }
+        },
+        "required": [
+          "input"
+        ],
+        "title": "PIIInput",
+        "type": "object"
+    },
+    "environment_variables": [
+        "WXG_SERVICE_INSTANCE_ID","WATSONX_REGION"
+    ],
+   "regions": ["ys1dev","ypqa","mcspdev","mcspqa","us-south","eu-de","ca-tor","au-syd","jp-tok","eu-gb"],
+   "cpd_supported": "true"
+}

ibm_watsonx_gov/tools/onboarding/create/prompt_safety_risk_detector.json

@@ -0,0 +1,69 @@
+{
+    "display_name": "PromptSafetyRisk Detector",
+    "tool_name": "prompt_safety_risk_detector",
+    "service_provider_type": "IBM",
+    "description": "Tool that detects off topic and prompt injection attempts in user input.",
+    "summary": "Tool that detects when user input contains prompt injection attacks or deviates from the intended domain (off-topic). Prompt injection attacks are malicious or manipulative attempts to override system instructions, alter the model’s behavior, or extract sensitive information. Off-topic detection ensures that interactions remain relevant to the defined scope. Together, these safeguards help maintain secure and focused conversations.",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": [
+        "Guardrails"
+    ],
+    "framework": [
+        "langchain",
+        "langgraph"
+    ],
+    "code": {
+        "source_code_url": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "config": {
+        "properties": {
+            "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float",
+                "default":0.8
+              }
+            },
+            "type": "object"
+    },
+    "schema": {
+        "properties": {
+            "input": {
+                "description": "Input text",
+                "title": "Input",
+                "type": "string"
+            },
+            "system_prompt": {
+                "description": "System Prompt",
+                "title": "System Prompt",
+                "type": "string"
+            },
+            "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float"
+            }
+        },
+        "required": [
+            "input",
+            "system_prompt"
+        ],
+        "title": "PromptSafetyRiskInput",
+        "type": "object"
+    },
+    "environment_variables": [
+        "WXG_SERVICE_INSTANCE_ID",
+        "WATSONX_REGION"
+    ],
+    "regions": [
+        "ys1dev",
+        "ypqa",
+        "us-south",
+        "eu-de"
+    ],
+    "cpd_supported": "false"
+}

ibm_watsonx_gov/tools/onboarding/create/topic_relevance_detector.json

@@ -0,0 +1,57 @@
+{
+    "display_name": "Topic Relevance Detector",
+    "tool_name": "topic_relevance_detector",
+    "service_provider_type": "IBM",
+    "description": "Tool that detects whether the user input is relevant to the topic defined in the system prompt and measures the degree of alignment.",
+    "summary":"Tool that detects whether the user input is relevant to the topic defined in the system prompt and measures the degree of alignment. It assesses how closely the input matches the intended subject area, ensuring conversations remain focused, accurate, and within scope. By identifying when input diverges from the defined topic, the tool helps maintain clarity, prevent distractions, and improve the quality of responses.",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": ["Guardrails"],
+    "framework": ["langchain","langgraph"],
+    "code": {
+        "source_code_url": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "config":{
+            "properties": {
+              "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float",
+                "default":0.8
+              }
+            },
+            "type": "object"
+    },
+    "schema":{
+        "properties": {
+            "input": {
+                "description": "Input text",
+                "title": "Input",
+                "type": "string"
+            },
+            "system_prompt": {
+                "description": "System Prompt",
+                "title": "System Prompt",
+                "type": "string"
+            },
+            "threshold": {
+                "description": "Threshold for calling the tool",
+                "title": "Threshold",
+                "type": "float"
+            }
+        },
+        "required": [
+          "input", "system_prompt"
+        ],
+        "title": "TopicRelevanceDetectorInput",
+        "type": "object"
+    },
+    "environment_variables": [
+        "WXG_SERVICE_INSTANCE_ID","WATSONX_REGION"
+    ],
+    "regions": ["ys1dev","ypqa","us-south","eu-de"],
+    "cpd_supported": "false"
+}

ibm_watsonx_gov/tools/onboarding/create/weather_tool.json

@@ -0,0 +1,39 @@
+{
+    "display_name": "Weather",
+    "tool_name": "weather_tool",
+    "service_provider_type": "IBM",
+    "description": "Retrieve the weather for a given location",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": ["Other"],
+    "framework": ["langchain","langgraph"],
+    "code": {
+        "source_code_base64": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "dependencies": {
+        "remote_services":[],
+        "run_time_packages":[]
+    },
+    "schema":{
+        "properties": {
+          "location": {
+            "description": "Name of the location",
+            "title": "Location",
+            "type": "string"
+          },
+          "country": {
+            "type": "string",
+            "description": "Name of the country",
+            "title": "Country"
+          }
+        },
+        "required": [
+          "location"
+        ],
+        "title": "WeatherInput",
+        "type": "object"
+      }
+}

ibm_watsonx_gov/tools/onboarding/create/webcrawler_tool.json

@@ -0,0 +1,34 @@
+{
+    "display_name": "Web Crawler",
+    "tool_name": "webcrawler_tool",
+    "service_provider_type": "IBM",
+    "description": "Gets the content of a web page",
+    "inventory_id": "<attribute_value>",
+    "reusable": "true",
+    "category": ["Search"],
+    "framework": ["langchain","langgraph"],
+    "code": {
+        "source_code_base64": "",
+        "run_time_details": {
+            "engine": "Python >=3.11"
+        }
+    },
+    "dependencies": {
+        "remote_services":[],
+        "run_time_packages":[]
+    },
+    "schema":{
+        "properties": {
+          "url": {
+            "description": "Url of the website",
+            "title": "Url",
+            "type": "string"
+          }
+        },
+        "required": [
+          "url"
+        ],
+        "title": "WebCrawlerInput",
+        "type": "object"
+    }
+}