list_ai_guard_rails

AIApi.list_ai_guard_rails(role_id, offset=None, limit=None, sortorder=None, sortby=None, projection_expression=None, filter_expression=None, component=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)[source]

List all guard rails

Retrieves a list of all guard rails accessible by the authenticated user.

Parameters:

  • role_id (str) – The role ID of the requesting user. (required)

  • offset (int) – Starting position for pagination (1-based).

  • limit (int) – Maximum number of items to return.

  • sortorder (str) – Sort direction (‘asc’ or ‘desc’).

  • sortby (str) – Attribute to sort by.

  • projection_expression (str) – Comma-separated list of attributes to include.

  • filter_expression (str) – Filter criteria for guard rail names.

  • component (str) – Component for which to list allowed guard rails.

  • _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:

GuardRailListResponse

Returns:

Returns the result object.