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

Security AI Assistant APIs #5620

Merged
merged 39 commits into from
Aug 8, 2024
Merged

Conversation

YulNaumenko
Copy link
Contributor

@YulNaumenko YulNaumenko commented Jul 29, 2024

Resolves #5562

Preview

Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented Jul 29, 2024

This pull request does not have a backport label. Could you fix it @YulNaumenko? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • v7.x is the label to automatically backport to the 7.x branch.
  • v7./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@jamesspi
Copy link
Collaborator

run docs-build

@peluja1012
Copy link
Contributor

run docs-build rebuild

@benironside benironside self-assigned this Aug 1, 2024
@YulNaumenko YulNaumenko marked this pull request as ready for review August 2, 2024 07:45
@YulNaumenko YulNaumenko requested a review from a team as a code owner August 2, 2024 07:45
Copy link
Contributor

@natasha-moore-elastic natasha-moore-elastic left a comment

Choose a reason for hiding this comment

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

Thanks for making the updates! Just a few minor tweaks, should be quick to apply.

docs/AI-for-security/api/chat-complete-api.asciidoc Outdated Show resolved Hide resolved
docs/AI-for-security/api/chat-complete-api.asciidoc Outdated Show resolved Hide resolved
docs/AI-for-security/api/chat-complete-api.asciidoc Outdated Show resolved Hide resolved
docs/AI-for-security/api/chat-complete-api.asciidoc Outdated Show resolved Hide resolved
docs/AI-for-security/api/conversation-api-find.asciidoc Outdated Show resolved Hide resolved
docs/siem-apis.asciidoc Outdated Show resolved Hide resolved
Copy link
Contributor

mergify bot commented Aug 8, 2024

This pull request is now in conflicts. Could you fix it @YulNaumenko? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b ai-assistant-apis upstream/ai-assistant-apis
git merge upstream/main
git push upstream ai-assistant-apis

Copy link
Contributor

mergify bot commented Aug 8, 2024

This pull request is now in conflicts. Could you fix it @YulNaumenko? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b ai-assistant-apis upstream/ai-assistant-apis
git merge upstream/main
git push upstream ai-assistant-apis

@benironside benironside merged commit 96204f6 into elastic:main Aug 8, 2024
3 checks passed
mergify bot pushed a commit that referenced this pull request Aug 8, 2024
* Security AI Assistant APIs

* -

* Add to SIEM APIs page

* Update path to AI-for-security

* Only conversation-api-create for now

* Update headings levels

* Update headings levels

* Create ai-for-security-index.asciidoc

* Update siem-apis.asciidoc

* Update includes

* initial troubleshoot of Table of Contents / sections / page org

* Adds other pages to the PR and fixes build errors

* ToC fix

* Moves AI Assistant API inside API docs section

* Changes title to "API" from "APIs"

* fixed the content

* Converts tables to asciidoc in chat-complete-api

* Converts tables to asciidoc in conversation-api-create

* Converts tables to asciidoc in conversation-api-update

* Escape links that are causing build to fail

* Escape parentheses in md links

* inserts escape chars in broken links

* Apply suggestions from code review

Start incorporating Nat's review

Co-authored-by: natasha-moore-elastic <[email protected]>

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <[email protected]>

* updated to to the comments

* -

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <[email protected]>

* Line edits of descriptions

* Revert "Line edits of descriptions"

This reverts commit d97a65e.

* Line edits

* minor tweak

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Co-authored-by: Pedro Jaramillo <[email protected]>
Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Co-authored-by: natasha-moore-elastic <[email protected]>
Co-authored-by: natasha-moore-elastic <[email protected]>
(cherry picked from commit 96204f6)
benironside pushed a commit that referenced this pull request Aug 8, 2024
* Security AI Assistant APIs

* -

* Add to SIEM APIs page

* Update path to AI-for-security

* Only conversation-api-create for now

* Update headings levels

* Update headings levels

* Create ai-for-security-index.asciidoc

* Update siem-apis.asciidoc

* Update includes

* initial troubleshoot of Table of Contents / sections / page org

* Adds other pages to the PR and fixes build errors

* ToC fix

* Moves AI Assistant API inside API docs section

* Changes title to "API" from "APIs"

* fixed the content

* Converts tables to asciidoc in chat-complete-api

* Converts tables to asciidoc in conversation-api-create

* Converts tables to asciidoc in conversation-api-update

* Escape links that are causing build to fail

* Escape parentheses in md links

* inserts escape chars in broken links

* Apply suggestions from code review

Start incorporating Nat's review

Co-authored-by: natasha-moore-elastic <[email protected]>

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <[email protected]>

* updated to to the comments

* -

* Apply suggestions from code review

Co-authored-by: natasha-moore-elastic <[email protected]>

* Line edits of descriptions

* Revert "Line edits of descriptions"

This reverts commit d97a65e.

* Line edits

* minor tweak

---------

Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Co-authored-by: Pedro Jaramillo <[email protected]>
Co-authored-by: Benjamin Ironside Goldstein <[email protected]>
Co-authored-by: natasha-moore-elastic <[email protected]>
Co-authored-by: natasha-moore-elastic <[email protected]>
(cherry picked from commit 96204f6)

Co-authored-by: Yuliia Naumenko <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Request] Documentation for AI Assistant API
7 participants