get_default_ai_guard_rail¶
- ArtificialIntelligenceApi.get_default_ai_guard_rail(role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶
Get the organization default AI guard rail
Returns the default guard rail with Configuration nested. Falls back to SYSTEM-Standard when no user default is set. Requires ai.view and AICore.
- Parameters:
role_id (str) – Role identifier used for authorization. Missing this header returns AUTH-1001. (required)
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.
- Return type:
- Returns:
Returns the result object.
Request and Response Examples¶
HTTP: GET /ai/guard-rails/default
Success (HTTP 200)¶
Successfully retrieved default guard rail details.
Errors¶
HTTP 400
Default guard rail not found or invalid request.
HTTP 500
Internal server error.