Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Large Language Models (LLMs)
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
Legal notices
Default Agent Settings
Get Tenant By Id
GET
/
default-agent-settings
/
{tenant_id}
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/default-agent-settings/{tenant_id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"settings": {
"model_settings": {
"base_llm": {
"model_name": "<string>",
"model_id": "<string>",
"model_params": {},
"guardrails": {
"hap": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
},
"social_bias": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
},
"pii": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
}
},
"system_prompt": "<string>"
},
"embeddings": {
"model_name": "<string>",
"model_id": "<string>"
},
"is_base_llm_enabled": true
},
"router_settings": {
"router_type": "unified",
"model_name": "<string>",
"model_id": "<string>",
"model_params": {},
"routing_prompt": "<string>",
"router_config": {
"continue_journey_on_none": true,
"confidence_threshold": 123,
"confidence_method": "perplexity"
}
},
"user_settings": {
"confirm_routing": true,
"clear_watsonx_assistant_context": false,
"clientside_shortlisting": false
},
"slot_filling_settings": {
"slot_filler_type": "unified",
"model_name": "<string>",
"model_id": "<string>",
"model_params": {}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Query Parameters
Response
200
application/json
Successful Response
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/default-agent-settings/{tenant_id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "<string>",
"name": "<string>",
"title": "<string>",
"description": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"created_by_username": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"settings": {
"model_settings": {
"base_llm": {
"model_name": "<string>",
"model_id": "<string>",
"model_params": {},
"guardrails": {
"hap": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
},
"social_bias": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
},
"pii": {
"input": {
"enabled": true,
"threshold": 123
},
"output": {
"enabled": true,
"threshold": 123
},
"mask": {
"remove_entity_value": true
}
}
},
"system_prompt": "<string>"
},
"embeddings": {
"model_name": "<string>",
"model_id": "<string>"
},
"is_base_llm_enabled": true
},
"router_settings": {
"router_type": "unified",
"model_name": "<string>",
"model_id": "<string>",
"model_params": {},
"routing_prompt": "<string>",
"router_config": {
"continue_journey_on_none": true,
"confidence_threshold": 123,
"confidence_method": "perplexity"
}
},
"user_settings": {
"confirm_routing": true,
"clear_watsonx_assistant_context": false,
"clientside_shortlisting": false
},
"slot_filling_settings": {
"slot_filler_type": "unified",
"model_name": "<string>",
"model_id": "<string>",
"model_params": {}
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.