set_ai_guard_rail_as_default

AIApi.set_ai_guard_rail_as_default(id, role_id, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)[source]

Set guard rail as default

Sets the specified guard rail as the default guard rail by setting the IsDefault flag to true. Only global guard rails can be set as default.

Parameters:

  • id (str) – The unique identifier of the guard rail to set as default. (required)

  • role_id (str) – The role ID of the requesting user. (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:

MessageStatus

Returns:

Returns the result object.