# RDA - User Guide

{% hint style="info" %}
You can find 'How to use RDA notebooks' as part of your AIOps Studio home.
{% endhint %}

{% hint style="warning" %}
Please note that both tags and bots are interchangeably used.&#x20;
{% endhint %}

### Built-in RDA functions

The following are the most commonly used built-in functions

| Function (Python)                | Terminal | Description                                                               |
| -------------------------------- | -------- | ------------------------------------------------------------------------- |
| bots()                           | bots     | View / Search list of bots from all sources                               |
| plugins()                        | plugins  | View / Search list of installed plugins.                                  |
| api\_models()                    |          | View / Search API Models for the bots that start with '@' (API Endpoints) |
| toolkit()                        |          | a tabbed group of reports with Bots, API Models, Plugins, and Datasets    |
| check\_connectivity()            |          | Check connectivity to data sources and verify credentials if applicable   |
| pexec(str)                       |          | Execute pipeline and return the resulting dataframe.                      |
| viz(df)                          |          | Visualize the dataframe                                                   |
| add\_dataset(data or file, name) |          | Add dataframe, file or URL as dataset in the RDA dataset repository       |
| get\_dataset(name)               |          | Get previously saved dataset                                              |
| list\_datasets()                 |          | Show list of all saved datasets                                           |
|                                  |          |                                                                           |

### Viewing Datasources and Tags <a href="#id-2.-viewing-datasources-and-tags" id="id-2.-viewing-datasources-and-tags"></a>

### plugins()

View / Search all installed RDA extensions.

### check\_connectivity() <a href="#check_connectivity" id="check_connectivity"></a>

Verify network access to all configured datasources.  If their credentials are used, verify the credentials also. This function also takes an optional argument which can be a datasource name (ex: `"snow"`)

### tags() <a href="#tags" id="tags"></a>

View / Search all datasource,  datasink, and control bots

### api\_models() <a href="#api_models" id="api_models"></a>

This function displays a list of all bots that are configured as API Endpoints. These bots are typically prefixed with an @ symbol. For each selected bot, this will display list parameters that should be provided as a combination of *and* (*&*) statements.

### toolkit() <a href="#toolkit" id="toolkit"></a>

This function will display Bots, Plugins, API Models and Datasets

### list\_datasets()

This method is identical to bot **@dm:recall** *name = "dataset-name"*


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.cloudfabrix.io/rda/rda-userguide.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
