Skip to content

RICommunity/robustintelligence-python

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
docs
docs
 
 
ri
ri
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
README.txt
README.txt
 
 
pyproject.toml
pyproject.toml
 
 

Repository files navigation

ri.apiclient

API methods for Robust Intelligence. Users must authenticate using the rime-api-key header.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 2.10.16
  • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://www.robustintelligence.com

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install robustintelligence

(you may need to run pip with root permission: sudo pip install robustintelligence)

Then import the package:

import ri

Getting Started

Please follow the installation procedure and then run the following:

import ri.apiclient
from ri import RIClient
from ri.apiclient.models import *
from ri.apiclient.rest import ApiException
from pprint import pprint


host_name = "http://<platform-domain>.rbst.io"

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: rime-api-key
rime_api_key = os.environ["API_KEY"]


with RIClient(host_name, rime_api_key) as client:
    workspace_workspace_id_uuid = 'workspace_workspace_id_uuid_example'  # str 
    workspace =  UpdateWorkspaceRequestWorkspace()  # UpdateWorkspaceRequestWorkspace  (optional)
    workspace_write_mask =  WorkspaceWriteMask()  # WorkspaceWriteMask  (optional)

    try:
        # UpdateWorkspace
        api_response = client.WorkspaceServiceApi.update_workspace(workspace_workspace_id_uuid, workspace=workspace, workspace_write_mask=workspace_write_mask)
        print("The response of WorkspaceServiceApi->update_workspace:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling WorkspaceServiceApi->update_workspace: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://.rbst.io

Class Method HTTP request Description
AgentManagerApi create_agent POST /v1/agents CreateAgent
AgentManagerApi create_firewall_agent POST /v1-beta/agents/firewall CreateFirewallAgent
AgentManagerApi delete_agent DELETE /v1/agents/{agentId.uuid} DeleteAgent
AgentManagerApi delete_firewall_instance DELETE /v1-beta/agents/firewall/{agentId.uuid}/firewall-instance/{firewallInstanceId.uuid} DeleteFirewallInstance
AgentManagerApi get_agent GET /v1/agents/{agentId.uuid} GetAgent
AgentManagerApi get_upgrade_for_agent GET /v1-beta/agents/{agentId.uuid}/upgrade GetUpgradeForAgent returns the desired state of the agent and the current status of the upgrade.
AgentManagerApi list_agents GET /v1/agents ListAgents
AgentManagerApi list_firewall_instances POST /v1-beta/agents/firewall/instances ListFirewallInstances
AgentManagerApi request_firewall_instance POST /v1-beta/agents/firewall/{agentId.uuid}/firewall-instance/request RequestFirewallInstance
AgentManagerApi upgrade_agent POST /v1-beta/agents/{agentId.uuid}/upgrade UpgradeAgent starts the process of upgrading the agent to the version of the control plane
CustomerManagedKeyServiceApi create_customer_managed_key POST /v1-beta/customer-managed-key CreateCustomerManagedKey
CustomerManagedKeyServiceApi delete_customer_managed_key DELETE /v1-beta/customer-managed-key DeleteCustomerManagedKey
CustomerManagedKeyServiceApi get_customer_managed_key GET /v1-beta/customer-managed-key GetCustomerManagedKey
CustomerManagedKeyServiceApi get_key_status GET /v1-beta/customer-managed-key/status GetKeyStatus
DataCollectorApi get_datapoints GET /v1-beta/data-collector/datapoints/{dataStreamId.uuid} GetDatapoints
DataCollectorApi get_predictions GET /v1-beta/data-collector/predictions/{modelId.uuid}/{dataStreamId.uuid} GetPredictions
DataCollectorApi register_data_stream POST /v1-beta/data-collector/datastream/{projectId.uuid} RegisterDataStream
DataCollectorApi store_datapoints PUT /v1-beta/data-collector/data/{dataStreamId.uuid} StoreDatapoints
DataCollectorApi store_predictions PUT /v1-beta/data-collector/predictions/{modelId.uuid} StorePredictions
DetectionApi list_detection_events GET /v1-beta/detection-events/{projectId.uuid} ListDetectionEvents
FeatureFlagApi get_limit_status GET /v1/feature-flags/{customerName}/limits/{limit} GetLimitStatus
FeatureFlagApi list_enabled_features GET /v1/feature-flags/{customerName}/features ListEnabledFeatures
FileScanningApi delete_file_scan_result DELETE /v1/file-scan-results/{fileScanId.uuid} DeleteFileScanResult
FileScanningApi delete_file_scan_result2 DELETE /v1-beta/file-scan-results/{fileScanId.uuid} DeleteFileScanResult
FileScanningApi get_file_scan_result GET /v1/file-scan-results/{fileScanId.uuid} GetFileScanResult
FileScanningApi get_file_scan_result2 GET /v1-beta/file-scan-results/{fileScanId.uuid} GetFileScanResult
FileScanningApi list_file_scan_results GET /v1/file-scan-results ListFileScanResults
FileScanningApi list_file_scan_results2 GET /v1-beta/file-scan-results ListFileScanResults
FileUploadApi delete_uploaded_file_url DELETE /v1-beta/datasets/upload-url DeleteUploadedFileURL
FileUploadApi get_dataset_file_upload_url GET /v1-beta/datasets/upload-url GetDatasetFileUploadURL
FileUploadApi get_dataset_file_upload_url2 POST /v1-beta/datasets/upload-url GetDatasetFileUploadURL
FileUploadApi get_model_directory_upload_urls GET /v1-beta/models/upload-url GetModelDirectoryUploadURL
FileUploadApi get_model_directory_upload_urls2 POST /v1-beta/models/upload-url GetModelDirectoryUploadURL
FileUploadApi list_uploaded_file_urls GET /v1-beta/uploaded-file-urls ListUploadedFileURLs
FirewallServiceApi create_firewall POST /v1/firewall CreateFirewall
FirewallServiceApi delete_firewall DELETE /v1/firewall/{firewallId.uuid} DeleteFirewall
FirewallServiceApi get_firewall GET /v1/firewall/{firewallId.uuid} GetFirewall
FirewallServiceApi get_url GET /v1-beta/firewall/{firewallId.uuid}/url GetURL
FirewallServiceApi update_firewall PUT /v1/firewall/{firewall.firewallId.uuid} UpdateFirewall
GenerativeValidationApi quick_scan POST /v1-beta/generative/testing/quick Start Generative AI Validation Quick Scan
GenerativeValidationApi results GET /v1-beta/generative/testing/{testRunId.uuid} Get Generative AI Validation Results
GenerativeValidationApi start_generative_test POST /v1-beta/generative/testing Start a Generative AI Validation Test
GenerativeValidationApi test_run GET /v1-beta/generative/testing/runs/{testRunId.uuid} Get Generative AI Validation Test Run
GenerativeValidationApi test_runs GET /v1-beta/generative/testing/workspaces/{workspaceId.uuid} List Generative AI Validation Test Runs
ImageRegistryApi create_image POST /v1/images CreateImage
ImageRegistryApi delete_image DELETE /v1/images/{name} DeleteImage
ImageRegistryApi get_image GET /v1/images/{name} GetImage
ImageRegistryApi list_images GET /v1/images ListImages
ImageRegistryApi list_images2 POST /v1/images/list ListImages
IntegrationServiceApi configure_integration POST /v1-beta/integrations/{integrationId.uuid} ConfigureIntegration
IntegrationServiceApi create_integration POST /v1-beta/integrations CreateIntegration
IntegrationServiceApi delete_integration DELETE /v1-beta/integrations/{integrationId.uuid} DeleteIntegration
IntegrationServiceApi get_integration GET /v1-beta/integrations/{integrationId.uuid} GetIntegration
IntegrationServiceApi list_workspace_integrations GET /v1-beta/integrations/workspace/{workspaceId.uuid} ListWorkspaceIntegrations
IntegrationServiceApi update_integration PUT /v1-beta/integrations/{integration.id.uuid} UpdateIntegration
JobReaderApi cancel_job POST /v1/jobs/cancel/{jobId} CancelJob
JobReaderApi get_job GET /v1/jobs/{jobId} GetJob
JobReaderApi get_project_id GET /v1/jobs/{jobId}/project-id GetProjectID
JobReaderApi get_test_run_id GET /v1/jobs/{jobId}/test-run-id GetTestRunID
JobReaderApi list_gai_test_job GET /v1-beta/jobs/generative/workspaces/{workspaceId.uuid} ListGAITestJob is a method to list all GAI test jobs for a given workspace.
JobReaderApi list_jobs_for_project GET /v1/jobs/project/{projectId.uuid} ListJobsForProject
ModelCardServiceApi create_model_card POST /v1-beta/modelcards CreateModelCard
ModelCardServiceApi delete_model_card DELETE /v1-beta/modelcards/{modelCardId.uuid} DeleteModelCard
ModelCardServiceApi get_model_card GET /v1-beta/modelcards/{modelCardId.uuid} GetModelCard
ModelCardServiceApi list_model_cards GET /v1-beta/modelcards/projects/{projectId} ListModelCards
ModelCardServiceApi update_model_card PUT /v1-beta/modelcards/{modelCard.modelCardId.uuid} UpdateModelCard
ModelTestingApi start_continuous_test POST /v1/continuous-tests/{firewallId.uuid} StartContinuousTest
ModelTestingApi start_file_scan POST /v1/file-scans StartFileScan
ModelTestingApi start_file_scan2 POST /v1-beta/file-scans StartFileScan
ModelTestingApi start_stress_test POST /v1/stress-tests/{projectId.uuid} StartStressTest
MonitorServiceApi create_custom_monitor POST /v1-beta/custom-monitors/{name} CreateCustomMonitor
MonitorServiceApi delete_custom_monitor DELETE /v1-beta/custom-monitors/{monitorId.uuid} DeleteCustomMonitor
MonitorServiceApi get_monitor_result GET /v1-beta/monitors/result/{monitorId.uuid} GetMonitorResult
MonitorServiceApi list_metric_identifiers GET /v1-beta/custom-monitors/metrics/{firewallId.uuid} ListMetricIdentifiers
MonitorServiceApi list_monitors GET /v1-beta/monitors/{firewallId.uuid} ListMonitors
MonitorServiceApi update_monitor PUT /v1-beta/monitors/{monitor.id.uuid} UpdateMonitor
NotificationSettingApi create_notification POST /v1/notif-settings CreateNotification
NotificationSettingApi delete_notification DELETE /v1/notif-settings/{id.uuid} DeleteNotification
NotificationSettingApi list_notifications GET /v1/notif-settings ListNotifications
NotificationSettingApi update_notification PUT /v1/notif-settings/{notification.id.uuid} UpdateNotification
ProjectServiceApi activate_schedule_for_project PUT /v1-beta/projects/{projectId.uuid}/schedule/{scheduleId.uuid}/activate ActivateScheduleForProject
ProjectServiceApi add_users_to_project POST /v1/projects/{projectId.uuid}/role/users AddUsersToProject
ProjectServiceApi create_project POST /v1/projects CreateProject
ProjectServiceApi deactivate_schedule_for_project PUT /v1-beta/projects/{projectId.uuid}/schedule/{scheduleId.uuid}/deactivate DeactivateScheduleForProject
ProjectServiceApi delete_project DELETE /v1/projects/{projectId.uuid} DeleteProject
ProjectServiceApi get_project GET /v1/projects/{projectId.uuid} GetProject
ProjectServiceApi get_project_url GET /v1/projects/{projectId.uuid}/url GetProjectURL
ProjectServiceApi get_workspace_roles_for_project GET /v1/projects/{projectId.uuid}/role/workspace GetWorkspaceRoleForProject
ProjectServiceApi list_projects GET /v1/projects ListProjects
ProjectServiceApi list_users_of_project GET /v1/projects/{projectId.uuid}/role/users ListUsersOfProject
ProjectServiceApi remove_user_from_project DELETE /v1/projects/{projectId.uuid}/role/users/{userId.uuid} RemoveUserFromProject
ProjectServiceApi update_project PUT /v1/projects/{projectId.uuid} UpdateProject
ProjectServiceApi update_user_of_project PUT /v1/projects/{projectId.uuid}/role/users/{user.userId.uuid} UpdateUserOfProject
ProjectServiceApi update_workspace_roles_for_project PUT /v1/projects/{projectId.uuid}/role/workspace UpdateWorkspaceRoleForProject
RIMEInfoApi get_rime_info GET /v1/rime-info GetRIMEInfo
RegistryServiceApi delete_dataset DELETE /v1/registry/dataset/{datasetId} DeleteDataset
RegistryServiceApi delete_model DELETE /v1/registry/model/{modelId.uuid} DeleteModel
RegistryServiceApi delete_prediction_set DELETE /v1/registry/prediction/{modelId.uuid}/{datasetId} DeletePredictionSet
RegistryServiceApi get_dataset GET /v1/registry/dataset GetDataset
RegistryServiceApi get_model GET /v1/registry/model GetModel
RegistryServiceApi get_prediction_set GET /v1/registry/prediction/{modelId.uuid}/{datasetId} GetPredictionSet
RegistryServiceApi list_datasets GET /v1/registry/{projectId.uuid}/dataset ListDatasets
RegistryServiceApi list_models GET /v1/registry/{projectId.uuid}/model ListModels
RegistryServiceApi list_prediction_sets GET /v1/registry/{projectId.uuid}/prediction ListPredictionSets
RegistryServiceApi register_dataset POST /v1/registry/{projectId.uuid}/dataset RegisterDataset
RegistryServiceApi register_model POST /v1/registry/{projectId.uuid}/model RegisterModel
RegistryServiceApi register_prediction_set POST /v1/registry/{projectId.uuid}/model/{modelId.uuid}/dataset/{datasetId}/prediction RegisterPredictionSet
ResultsReaderApi delete_test_run DELETE /v1/test-runs/{testRunId} DeleteTestRun
ResultsReaderApi get_batch_result GET /v1/test-runs/{testRunId}/batch-result/{testType} GetBatchResult
ResultsReaderApi get_category_results GET /v1/category-results/{testRunId} GetCategoryResults
ResultsReaderApi get_feature_result GET /v1/test-runs/{testRunId}/feature-result/{urlSafeFeatureId} GetFeatureResult
ResultsReaderApi get_test_config GET /v1-beta/test-runs/{testRunId}/test-config/{configName} GetTestConfig
ResultsReaderApi get_test_run GET /v1/test-runs/{testRunId} GetTestRun
ResultsReaderApi list_batch_results GET /v1/batch-results ListBatchResults
ResultsReaderApi list_feature_results GET /v1/feature-results ListFeatureResults
ResultsReaderApi list_monitor_categories GET /v1-beta/test-runs/test-category/monitor ListMonitorCategories
ResultsReaderApi list_summary_tests GET /v1/summary-tests ListSummaryTests
ResultsReaderApi list_test_cases GET /v1/test-cases ListTestCases
ResultsReaderApi list_test_runs GET /v1/test-runs ListTestRuns
ResultsReaderApi list_validation_categories GET /v1-beta/test-runs/test-category/validation ListValidationCategories
ResultsReaderApi rename_test_run POST /v1/test-runs/rename/{testRunId} RenameTestRun
ScheduleServiceApi create_schedule POST /v1-beta/schedules CreateSchedule creates a schedule.
ScheduleServiceApi delete_schedule DELETE /v1-beta/schedules/{scheduleId.uuid} DeleteSchedule deletes a schedule.
ScheduleServiceApi get_schedule GET /v1-beta/schedules/{scheduleId.uuid} GetSchedule gets a schedule.
ScheduleServiceApi update_schedule PATCH /v1-beta/schedules/{schedule.scheduleId.uuid} UpdateSchedule updates a schedule.
SecurityDBApi get_model_security_report GET /v1-beta/security-report/model GetModelSecurityReport
SecurityDBApi list_model_security_reports GET /v1-beta/security-report/models ListModelSecurityReports
UserApi create_api_token POST /v1/users/api-tokens CreateAPIToken
UserApi create_user POST /v1/users CreateUser
UserApi delete_api_token DELETE /v1/users/api-tokens/{id.uuid} DeleteAPIToken
UserApi delete_user DELETE /v1/users/{userId.uuid} DeleteUser
UserApi get_user GET /v1/users/{userId.uuid} GetUser
UserApi list_api_tokens GET /v1/users/api-tokens ListAPITokens
UserApi list_current_user_roles GET /v1/users/roles ListCurrentUserRoles
UserApi list_users GET /v1/users ListUsers
UserApi reset_password POST /v1/users/reset-password/{userId.uuid} ResetPassword
UserApi update_agent_api_token PUT /v1/users/agent-api-tokens UpdateAgentAPIToken
UserApi update_user PUT /v1/users/{user.id.uuid} UpdateUser
WorkspaceServiceApi add_users_to_workspace POST /v1/workspace/{workspaceId.uuid}/users AddUsersToWorkspace
WorkspaceServiceApi create_workspace POST /v1/workspace CreateWorkspace
WorkspaceServiceApi delete_workspace DELETE /v1/workspace/{workspaceId.uuid} DeleteWorkspace
WorkspaceServiceApi get_workspace GET /v1/workspace/{workspaceId.uuid} GetWorkspace
WorkspaceServiceApi list_project_tags_in_workspace GET /v1/workspace/{workspaceId.uuid}/tags/project ListProjectTagsInWorkspace
WorkspaceServiceApi list_users_of_workspace GET /v1/workspace/{workspaceId.uuid}/users ListUsersOfWorkspace
WorkspaceServiceApi list_workspaces GET /v1/workspace ListWorkspaces
WorkspaceServiceApi remove_user_from_workspace DELETE /v1/workspace/{workspaceId.uuid}/users/{userId.uuid} RemoveUserFromWorkspace
WorkspaceServiceApi update_user_of_workspace PUT /v1/workspace/{workspaceId.uuid}/users/{user.userId.uuid} UpdateUserOfWorkspace
WorkspaceServiceApi update_workspace PUT /v1/workspace/{workspace.workspaceId.uuid} UpdateWorkspace

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

rime-api-key

  • Type: API key
  • API key parameter name: rime-api-key
  • Location: HTTP header

Author

dev@robustintelligence.com

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages