list_ai_guard_rails

ArtificialIntelligenceApi.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)

List AI guard rails accessible to the user

Returns guard rails the caller can access, with optional filter, sort, pagination, projection, and component restriction. AICore must be enabled.

Parameters:

  • role_id (str) – Role identifier used for authorization. Missing this header returns AUTH-1001. (required)

  • offset (int) – 1-based page start. offset=1 is the first item. Defaults to 1.

  • limit (int) – Maximum items on this page. Defaults to 100. Values greater than 1000 return IPV-1050.

  • sortorder (str) – Sort direction. desc (default) sorts descending; any other value sorts ascending.

  • sortby (str) – Attribute to sort by. Defaults to LastModifiedTime. The attribute must exist on list items.

  • projection_expression (str) – Comma-separated attributes to keep on each list item after pagination.

  • filter_expression (str) – Filter as key:value pairs separated by commas (AND). GuardRailName supports wildcard . Example GuardRailName:SYSTEM.

  • component (str) – When set, list only guard rails allowed for that AI component. Supported values are knowledgebases, agents, jobs, datalabs, nl2sql, data-pipelines, datasets, chats.

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

Request and Response Examples

HTTP: GET /ai/guard-rails

Success (HTTP 200)

Successfully retrieved guard rails. Returns list of guard rails.

Errors

HTTP 400

Invalid request.

HTTP 500

Internal server error.