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

## What does this PR do? #870

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

patrykkopycinski
Copy link
Contributor

Adds kibana/security_ai_prompt to support security AI prompt assets.

Why is it important?

In order to have the flexibility to tweak AI prompts outside of our regular ESS release schedule, kibana/security_ai_prompt assets introduce the ability to ship prompt updates for the security AI Assistant and Attack Discovery.

Checklist

Related issues

What does this PR do?

Why is it important?

Checklist

Related issues

Adds `kibana/security_ai_prompt` to support security AI prompt assets.

## Why is it important?

In order to have the flexibility to tweak AI prompts outside of our regular ESS release schedule, `kibana/security_ai_prompt` assets introduce the ability to ship prompt updates for the security AI Assistant and Attack Discovery.

## Checklist

- [x] I have added test packages to [`test/packages`](https://github.com/elastic/package-spec/tree/main/test/packages) that prove my change is effective.
- [x] I have added an entry in [`spec/changelog.yml`](https://github.com/elastic/package-spec/blob/main/spec/changelog.yml).

## Related issues

- <elastic/security-team#11196>
@patrykkopycinski
Copy link
Contributor Author

test integrations

@elasticmachine
Copy link

elasticmachine commented Feb 11, 2025

💔 Build Failed

Failed CI Steps

History

Copy link
Member

@jsoriano jsoriano 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 some questions about how this is expected to be used. Thanks!

- description: A security AI prompt asset file
type: file
contentMediaType: "application/json"
pattern: '^{PACKAGE_NAME}-.+\.json$'
Copy link
Member

Choose a reason for hiding this comment

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

How are these prompts related to the data collected by the integration?

If these prompts are not specially related to any data, maybe they should be supported only in content packages.

Copy link
Member

Choose a reason for hiding this comment

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

A sample package with a more real world use case could help to illustrate this.

@@ -135,7 +144,7 @@ spec:
contentMediaType: "application/json"
pattern: '^{PACKAGE_NAME}-.+\.json$'
forbiddenPatterns:
- '^.+-(ecs|ECS)\.json$' # ECS suffix is forbidden
- '^.+-(ecs|ECS)\.json$' # ECS suffix is forbidden
versions:
Copy link
Member

Choose a reason for hiding this comment

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

We should add a version patch so this cannot be used in older versions of the spec.

Suggested change
versions:
versions:
- before: 3.4.0
patch:
- op: remove
path: "/contents/6" # remove AI prompt definitions

Comment on lines +68 to +73
- description: Folder containing security AI prompt assets
type: folder
name: security_ai_prompt
required: false
contents:
- description: A security AI prompt asset file
Copy link
Member

Choose a reason for hiding this comment

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

Are they specific to security or they could be used in other solutions?

Suggested change
- description: Folder containing security AI prompt assets
type: folder
name: security_ai_prompt
required: false
contents:
- description: A security AI prompt asset file
- description: Folder containing AI prompt assets
type: folder
name: ai_prompt
required: false
contents:
- description: An AI prompt asset file

@jsoriano jsoriano mentioned this pull request Feb 11, 2025
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants