Skip to content
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

Feat: AI Azure Content Safety plugin doc #7326

Merged
merged 10 commits into from
May 21, 2024

Conversation

lena-larionova
Copy link
Contributor

@lena-larionova lena-larionova commented May 1, 2024

Description

Docs for new AI Azure Content Safety plugin.

https://konghq.atlassian.net/browse/DOCU-3767

Testing instructions

Preview link: https://deploy-preview-7326--kongdocs.netlify.app/hub/kong-inc/ai-azure-content-safety/unreleased/

Checklist

@lena-larionova lena-larionova added the review:sme Request for SME review, external to the docs team. label May 1, 2024
@lena-larionova lena-larionova added this to the Gateway 3.7 milestone May 1, 2024
Copy link

netlify bot commented May 1, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 1cdcd4d
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/664c4ead55d441000775391f
😎 Deploy Preview https://deploy-preview-7326--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 92 (🟢 up 1 from production)
Accessibility: 93 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@lena-larionova
Copy link
Contributor Author

@ttyS0e could you please review this doc for the new plugin and see if there's anything that could be added? I just based it on your PR.

Copy link
Contributor

@tysoekong tysoekong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have completed this up to what the plugin can do right now.

@tysoekong tysoekong marked this pull request as ready for review May 13, 2024 15:13
@tysoekong tysoekong requested a review from a team as a code owner May 13, 2024 15:13
@tysoekong tysoekong force-pushed the feat/ai-azure-content-safety branch from 3cc60a1 to 78f9182 Compare May 16, 2024 09:29
@lena-larionova
Copy link
Contributor Author

There's an issue with the way that arrays of records are being rendered in the output right now, I'm asking Fabian to help out. If we can't fix it quickly, I'll just revert the examples to plain yaml.

TODO: we'll need to do the same with konnect
You may also be interested in the following AI plugins:
* [AI Proxy](/hub/kong-inc/ai-proxy/)
* [AI Request Transformer](/hub/kong-inc/ai-request-transformer/)
* [AI Response Transformer](/hub/kong-inc/ai-request-transformer/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* [AI Response Transformer](/hub/kong-inc/ai-request-transformer/)
* [AI Response Transformer](/hub/kong-inc/ai-request-transformer/)
{% if_version gte:3.7.x %}
* [AI Rate Limiting Advanced](/hub/kong-inc/ai-rate-limiting-advanced/)
{% endif_version %}

This one was added to AI Proxy's homepage, I wonder if this Other AI plugins section should be an include since it's used on all the AI plugin overview pages. It would be easier to maintain that way.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. We could just rename it to "All AI plugins" or just "AI plugins" and put them in an include, like you said. Right now the list is different for each plugin since it doesn't contain a link to the plugin you're already on. But I don't think it's a big deal to do that.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Going to do this separately, outside of this plugin's PR. This PR is already getting overloaded with extra/not the most related content.

Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a few small comments!

app/_hub/kong-inc/ai-azure-content-safety/how-to/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/ai-azure-content-safety/how-to/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/ai-azure-content-safety/how-to/_index.md Outdated Show resolved Hide resolved

## Authentication

In each instance of the plugin, it supports one of:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean you have to pick either content safety key or managed identity auth? Or that you can have one key as well as one managed identity auth at the same time?

app/_hub/kong-inc/ai-azure-content-safety/how-to/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/ai-azure-content-safety/how-to/_index.md Outdated Show resolved Hide resolved
app/_hub/kong-inc/ai-azure-content-safety/how-to/_index.md Outdated Show resolved Hide resolved
Co-authored-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@lena-larionova lena-larionova merged commit 29a53c6 into main May 21, 2024
15 checks passed
@lena-larionova lena-larionova deleted the feat/ai-azure-content-safety branch May 21, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
review:sme Request for SME review, external to the docs team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants