Skip to content

Commit

Permalink
Deploy Resilient/resilient-community-apps to github.ibm.com/Resilient…
Browse files Browse the repository at this point in the history 
…/resilient-community-apps.git:gh-pages
  • Loading branch information
@traviscibot
traviscibot committed Dec 5, 2024
1 parent 65f97f6 commit 36048ba
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 25 deletions.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/fn_watsonx_analyst/README.doctree
View file
Binary file not shown.
23 changes: 12 additions & 11 deletions _sources/fn_watsonx_analyst/README.md.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
- [Key Features](#key-features)
- [Requirements](#requirements)
- [Watsonx.ai Subscription and Project](#watsonxai-subscription-and-project)
- [1. Watsonx.ai Project ID](#1-watsonxai-project-id)
- [2. IBM Cloud IAM API Key](#2-ibm-cloud-iam-api-key)
- [3. Watsonx.ai Endpoint URL](#3-watsonxai-endpoint-url)
- [Watsonx.ai Project ID](#watsonxai-project-id)
- [IBM Cloud IAM API Key](#ibm-cloud-iam-api-key)
- [Watsonx.ai Endpoint URL](#watsonxai-endpoint-url)
- [SOAR platform](#soar-platform)
- [QRadar Suite](#qradar-suite)
- [Proxy Server](#proxy-server)
Expand Down Expand Up @@ -43,8 +43,9 @@

## Release Notes

| Version | Date | Notes |
|---------|---------|-------------------------------------------------------------------------|
| Version | Date | Notes |
|---------|---------|-------------------------------------------------------------------------------|
| 1.0.1 | 12/2024 | Bugfix for SOAR versions <= 51.0.2.1 and >= 51.0.4.1 for Note Conversation Function. |
| 1.0.0 | 12/2024 | Initial "**Early Access**" release. Uses watsonx.ai SaaS Version `2023-05-29` |

---
Expand Down Expand Up @@ -76,7 +77,7 @@

> These instructions work as of 2024-11-25. These steps may become outdated due to changes made outside of this app.

#### 1. Watsonx.ai Project ID
#### Watsonx.ai Project ID
Navigate to the Projects page
![](doc/images/watsonx-ai-04-nav-to-projects.png)

Expand All @@ -88,7 +89,7 @@ Navigate to your project.
Under the `Manage` tab, on the `General` section, copy the Project ID, you will need this later when configuring the app.
![](doc/images/watsonx-ai-05-copy-project-id.png)

#### 2. IBM Cloud IAM API Key
#### IBM Cloud IAM API Key

To use watsonx.ai from the _watsonx.ai for SOAR_ app, you'll need an IBM Cloud IAM API Key. To generate an API key, click on the menu icon in the top left of the watsonx.ai dashboard and open *Access (IAM)* under the *Administration* menu.

Expand All @@ -103,7 +104,7 @@ The *Access IAM* dashboard will open...

Take note of the API key as this will also be used during app configuration.

#### 3. Watsonx.ai Endpoint URL
#### Watsonx.ai Endpoint URL

The endpoint will depend on which region your watsonx.ai project was created in. You can see which region you're using in the watsonx.ai dashboard in the dropdown at the top-right, next to the user icon.

Expand Down Expand Up @@ -174,9 +175,9 @@ The following table provides the settings you need to configure the app. These s

| Config | Required | Example | Description |
|------------------------|:--------:|-------------------------------------|------------------------------------------------------------------------------------|
| **watsonx_api_key** | Yes | 0123-4567-89ab-cdef | Your watsonx.ai API key - see [IBM Cloud IAM API Key](#2-ibm-cloud-iam-api-key) |
| **watsonx_endpoint** | Yes | `https://us-south.ml.cloud.ibm.com` | The watsonx.ai API URL - see [watsonx.ai Endpoint URL](#3-watsonxai-endpoint-url) |
| **watsonx_project_id** | Yes | 0123-4567-89ab-cdef | The watsonx.ai project id - see [watsonx.ai Project ID](#3-watsonxai-endpoint-url) |
| **watsonx_api_key** | Yes | 0123-4567-89ab-cdef | Your watsonx.ai API key - see [IBM Cloud IAM API Key](#ibm-cloud-iam-api-key) |
| **watsonx_endpoint** | Yes | `https://us-south.ml.cloud.ibm.com` | The watsonx.ai API URL - see [watsonx.ai Endpoint URL](#watsonxai-endpoint-url) |
| **watsonx_project_id** | Yes | 0123-4567-89ab-cdef | The watsonx.ai project id - see [watsonx.ai Project ID](#watsonxai-endpoint-url) |


#### Adding the secrets to the App Configuration
Expand Down
30 changes: 17 additions & 13 deletions fn_watsonx_analyst/README.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -415,9 +415,9 @@ <h2>Table of Contents<!-- omit in toc --><a class="headerlink" href="#table-of-c
<ul>
<li><p><a class="reference internal" href="#watsonxai-subscription-and-project"><span class="xref myst">Watsonx.ai Subscription and Project</span></a></p>
<ul>
<li><p><a class="reference internal" href="#1-watsonxai-project-id"><span class="xref myst">1. Watsonx.ai Project ID</span></a></p></li>
<li><p><a class="reference internal" href="#2-ibm-cloud-iam-api-key"><span class="xref myst">2. IBM Cloud IAM API Key</span></a></p></li>
<li><p><a class="reference internal" href="#3-watsonxai-endpoint-url"><span class="xref myst">3. Watsonx.ai Endpoint URL</span></a></p></li>
<li><p><a class="reference internal" href="#watsonxai-project-id"><span class="xref myst">Watsonx.ai Project ID</span></a></p></li>
<li><p><a class="reference internal" href="#ibm-cloud-iam-api-key"><span class="xref myst">IBM Cloud IAM API Key</span></a></p></li>
<li><p><a class="reference internal" href="#watsonxai-endpoint-url"><span class="xref myst">Watsonx.ai Endpoint URL</span></a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#soar-platform"><span class="xref myst">SOAR platform</span></a></p></li>
Expand Down Expand Up @@ -485,7 +485,11 @@ <h2>Release Notes<a class="headerlink" href="#release-notes" title="Link to this
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>1.0.0</p></td>
<tr class="row-even"><td><p>1.0.1</p></td>
<td><p>12/2024</p></td>
<td><p>Bugfix for SOAR versions &lt;= 51.0.2.1 and &gt;= 51.0.4.1 for Note Conversation Function.</p></td>
</tr>
<tr class="row-odd"><td><p>1.0.0</p></td>
<td><p>12/2024</p></td>
<td><p>Initial “<strong>Early Access</strong>” release. Uses watsonx.ai SaaS Version <code class="docutils literal notranslate"><span class="pre">2023-05-29</span></code></p></td>
</tr>
Expand Down Expand Up @@ -530,7 +534,7 @@ <h3>Watsonx.ai Subscription and Project<a class="headerlink" href="#watsonx-ai-s
<div><p>These instructions work as of 2024-11-25. These steps may become outdated due to changes made outside of this app.</p>
</div></blockquote>
<section id="watsonx-ai-project-id">
<h4>1. Watsonx.ai Project ID<a class="headerlink" href="#watsonx-ai-project-id" title="Link to this heading"></a></h4>
<h4>Watsonx.ai Project ID<a class="headerlink" href="#watsonx-ai-project-id" title="Link to this heading"></a></h4>
<p>Navigate to the Projects page
<img alt="" src="../_images/watsonx-ai-04-nav-to-projects.png" /></p>
<p>If you have not created a project yet, you can create one now, using the <code class="docutils literal notranslate"><span class="pre">New</span> <span class="pre">Project</span> <span class="pre">+</span></code> button on the top-right.
Expand All @@ -540,7 +544,7 @@ <h4>1. Watsonx.ai Project ID<a class="headerlink" href="#watsonx-ai-project-id"
<img alt="" src="../_images/watsonx-ai-05-copy-project-id.png" /></p>
</section>
<section id="ibm-cloud-iam-api-key">
<h4>2. IBM Cloud IAM API Key<a class="headerlink" href="#ibm-cloud-iam-api-key" title="Link to this heading"></a></h4>
<h4>IBM Cloud IAM API Key<a class="headerlink" href="#ibm-cloud-iam-api-key" title="Link to this heading"></a></h4>
<p>To use watsonx.ai from the <em>watsonx.ai for SOAR</em> app, you’ll need an IBM Cloud IAM API Key. To generate an API key, click on the menu icon in the top left of the watsonx.ai dashboard and open <em>Access (IAM)</em> under the <em>Administration</em> menu.</p>
<p><img alt="screenshot: watsonx-api-1" src="../_images/watsonx-ai-03-key1.png" /></p>
<p>The <em>Access IAM</em> dashboard will open…</p>
Expand All @@ -552,7 +556,7 @@ <h4>2. IBM Cloud IAM API Key<a class="headerlink" href="#ibm-cloud-iam-api-key"
<p>Take note of the API key as this will also be used during app configuration.</p>
</section>
<section id="watsonx-ai-endpoint-url">
<h4>3. Watsonx.ai Endpoint URL<a class="headerlink" href="#watsonx-ai-endpoint-url" title="Link to this heading"></a></h4>
<h4>Watsonx.ai Endpoint URL<a class="headerlink" href="#watsonx-ai-endpoint-url" title="Link to this heading"></a></h4>
<p>The endpoint will depend on which region your watsonx.ai project was created in. You can see which region you’re using in the watsonx.ai dashboard in the dropdown at the top-right, next to the user icon.</p>
<p>Find the relevant Endpoint for your region at https://cloud.ibm.com/apidocs/watsonx-ai#endpoint-url.</p>
<blockquote>
Expand Down Expand Up @@ -661,17 +665,17 @@ <h3>Configuring the App<a class="headerlink" href="#configuring-the-app" title="
<tr class="row-even"><td><p><strong>watsonx_api_key</strong></p></td>
<td class="text-center"><p>Yes</p></td>
<td><p>0123-4567-89ab-cdef</p></td>
<td><p>Your watsonx.ai API key - see <a class="reference internal" href="#2-ibm-cloud-iam-api-key"><span class="xref myst">IBM Cloud IAM API Key</span></a></p></td>
<td><p>Your watsonx.ai API key - see <a class="reference internal" href="#ibm-cloud-iam-api-key"><span class="xref myst">IBM Cloud IAM API Key</span></a></p></td>
</tr>
<tr class="row-odd"><td><p><strong>watsonx_endpoint</strong></p></td>
<td class="text-center"><p>Yes</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">https://us-south.ml.cloud.ibm.com</span></code></p></td>
<td><p>The watsonx.ai API URL - see <a class="reference internal" href="#3-watsonxai-endpoint-url"><span class="xref myst">watsonx.ai Endpoint URL</span></a></p></td>
<td><p>The watsonx.ai API URL - see <a class="reference internal" href="#watsonxai-endpoint-url"><span class="xref myst">watsonx.ai Endpoint URL</span></a></p></td>
</tr>
<tr class="row-even"><td><p><strong>watsonx_project_id</strong></p></td>
<td class="text-center"><p>Yes</p></td>
<td><p>0123-4567-89ab-cdef</p></td>
<td><p>The watsonx.ai project id - see <a class="reference internal" href="#3-watsonxai-endpoint-url"><span class="xref myst">watsonx.ai Project ID</span></a></p></td>
<td><p>The watsonx.ai project id - see <a class="reference internal" href="#watsonxai-endpoint-url"><span class="xref myst">watsonx.ai Project ID</span></a></p></td>
</tr>
</tbody>
</table>
Expand Down Expand Up @@ -1282,9 +1286,9 @@ <h3>For Support<a class="headerlink" href="#for-support" title="Link to this hea
</li>
<li><a class="reference internal" href="#requirements">Requirements</a><ul>
<li><a class="reference internal" href="#watsonx-ai-subscription-and-project">Watsonx.ai Subscription and Project</a><ul>
<li><a class="reference internal" href="#watsonx-ai-project-id">1. Watsonx.ai Project ID</a></li>
<li><a class="reference internal" href="#ibm-cloud-iam-api-key">2. IBM Cloud IAM API Key</a></li>
<li><a class="reference internal" href="#watsonx-ai-endpoint-url">3. Watsonx.ai Endpoint URL</a></li>
<li><a class="reference internal" href="#watsonx-ai-project-id">Watsonx.ai Project ID</a></li>
<li><a class="reference internal" href="#ibm-cloud-iam-api-key">IBM Cloud IAM API Key</a></li>
<li><a class="reference internal" href="#watsonx-ai-endpoint-url">Watsonx.ai Endpoint URL</a></li>
</ul>
</li>
<li><a class="reference internal" href="#soar-platform">SOAR platform</a></li>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 36048ba

Please sign in to comment.