-
Notifications
You must be signed in to change notification settings - Fork 44
Add ai cop docs [LK-1746] #2528
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
4ae5303
start docs on ai cop
joanasteodoro acdb16d
add sections documentation
joanasteodoro 46c0536
Update docs/organizations/ai-risk-hub.md
joanasteodoro 4182001
Update docs/organizations/ai-risk-hub.md
joanasteodoro 4c0665b
update dashboard img
joanasteodoro 739e73e
Merge branch 'master' into add-ai-cop-docs-lk-1746
joanasteodoro File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| --- | ||
| description: The organization's AI Risk Hub dashboard provides an overview of all the AI issues detected in the repositories applied to the organization's AI Policy standard and your organization's risk level based on your AI practices. | ||
| --- | ||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| # AI Risk Hub | ||
|
|
||
| The **AI Risk Hub** dashboard provides an overview of all the AI issues detected in the repositories applied to the organization's AI Policy standard and your organization's risk level based on your AI practices. Here, you can navigate through the issues detected in your repositories and filter them by severity and category. You can also filter the issues by selecting specific repositories or using [the segments that you have set up](segments.md). | ||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| !!! important | ||
| Currently this tab is a preview of a Business tier feature. | ||
|
|
||
|  | ||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| To access the AI Risk Hub dashboard, select an organization from the top navigation bar and click on the **AI Risk Hub** tab at the top of the page. | ||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| The AI Risk Hub dashboard includes the following sections to help you monitor AI risk in your organization: | ||
|
|
||
| - [AI Policy Compliance](#ai-policy-compliance) | ||
| - [Repositories with most AI issues](#repositories-with-most-ai-issues) | ||
| - [Risk Level](#risk-level) | ||
| - [AI Risk Checklist](#ai-risk-checklist) | ||
| ## AI Policy Compliance | ||
|
|
||
| Our AI Policy is a pre-defined, curated ruleset designed to prevent risks and vulnerabilities that are inherent to AI code from entering the codebase – which can be enforced immediately across all repositories and pull request checks. | ||
|
Check failure on line 24 in docs/organizations/ai-risk-hub.md
|
||
| You can enable Codacy's AI Policy by clicking on the button on the right side of the section. This creates a coding standard that applies AI related patterns to your repositories, safeguarding them from AI risks. | ||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| When the policy is enabled, you are able to view a real distribution of the AI issues found distributed by severity and AI category. | ||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| When you already have the AI Policy enabled, you can see an edit button which allows you to edit the repositories that have this policy applied. | ||
|
|
||
|  | ||
|
|
||
| The AI Policy covers four groups of AI-specific risks: | ||
|
|
||
| ### Unapproved model calls | ||
|
|
||
| Ensure no disallowed models are used in production and get visibility around any compliance misuses. | ||
|
|
||
| ### AI Safety | ||
|
|
||
| Ensures safety practices are enforced and applied with the use of these new technologies. | ||
|
|
||
| ### Hardcoded Secrets | ||
|
|
||
| Ensures anything created or used by AI is protected from misusage. | ||
|
|
||
| ### Vulnerabilities (Insecure dependencies / SCA) | ||
|
|
||
| Ensures protection on all fronts, by integrating vulnerability detection through your entire organization. | ||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| ## Repositories with most AI issues | ||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| This list displays repositories in descending order based on the number of AI issues. Depending on the filters applied, the list will show repositories with the most AI open issues, grouped by severity or AI category. | ||
|
|
||
|
|
||
|  | ||
|
|
||
| ## Risk Level | ||
|
|
||
| This panel shows the organizational AI Risk Level based on the implementation (or lack) of a range of essential AI safeguards that can be enabled in Codacy. | ||
| The possible risk levels are: High, Medium, and Low, considering special control factors you can enable in Codacy. | ||
| These control factors are specified in the **AI Risk Checklist**. | ||
|
|
||
|  | ||
|
|
||
| ## AI Risk Checklist | ||
|
|
||
| With most repositories today being subject to GenAI code contributions, the checklist covers essential source code controls that we recommend to enable across all projects within your organization: | ||
|
|
||
| - AI Policy enabled: Enable the AI Policy inside the AI Risk Hub tab. | ||
| - Coverage enabled: Set up code coverage for your repositories. See how to [upload coverage data](../coverage-reporter/index.md) to Codacy. | ||
| - Enforced gates: Add [gates to your repositories](../repositories-configure/adjusting-quality-gates.md), and preferentially [apply repositories to gate policies](./using-gate-policies.md). | ||
| - Protected pull requests: Protect your pull requests by [enforcing quality gates](../getting-started/integrating-codacy-with-your-git-workflow.md#blocking-pull-requests). | ||
| - Daily vulnerability scans: [Enable Proactive SCA](./managing-security-and-risk.md#dependencies-list) to protect your repositories from dependencies vulnerabilities. | ||
| - Applications scanned: [Enable App scanning](./managing-security-and-risk.md#app-scanning) to scan Web Applications and APIs for security vulnerabilities. | ||
|
Check failure on line 74 in docs/organizations/ai-risk-hub.md
|
||
|
|
||
joanasteodoro marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|  | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.