From da278f8a53ebb4fcd2cb3ffb245401ad888c6356 Mon Sep 17 00:00:00 2001 From: Rosie Yohannan Date: Tue, 9 Jul 2024 13:26:01 +0100 Subject: [PATCH 1/3] Add intelligent summaries page --- jekyll/_cci2/intelligent-summaries.adoc | 28 +++++++++++++++++++++++++ jekyll/_data/sidenav.yml | 4 ++++ 2 files changed, 32 insertions(+) create mode 100644 jekyll/_cci2/intelligent-summaries.adoc diff --git a/jekyll/_cci2/intelligent-summaries.adoc b/jekyll/_cci2/intelligent-summaries.adoc new file mode 100644 index 00000000000..67d65f526b1 --- /dev/null +++ b/jekyll/_cci2/intelligent-summaries.adoc @@ -0,0 +1,28 @@ +--- +contentTags: + platform: + - Cloud +--- += Intelligent summaries +:page-layout: classic-docs +:page-liquid: +:page-description: An overview of the intelligent summaries feature, an AI enabled helper feature in CircleCI that provides help with build failures +:icons: font +:experimental: + +CircleCI's intelligent summaries provide contextual help with build failures. Select btn:[Explain this error] from a failed job's step output to see an AI-generated summary of the error, along with suggestions on how to fix it. + +== Enable intelligent summaries + +The intelligent summaries feature is **disabled** by default. You can opt-in to the feature, as follows: + +NOTE: Only organization administrators can enable or disable the feature. + +. From the link:https://app.circleci.com/home/[CircleCI web app] select your organization card. +. Select **Organization Settings** from the sidebar. +. Select **Advanced** from the menu. +. Use the "Enable intelligent summaries of build failure messages" toggle to enable or disable the feature. + +== Use intelligent summaries + +== Privacy and security diff --git a/jekyll/_data/sidenav.yml b/jekyll/_data/sidenav.yml index 3e47587da79..07dd0318640 100644 --- a/jekyll/_data/sidenav.yml +++ b/jekyll/_data/sidenav.yml @@ -662,6 +662,10 @@ en: - name: Developer toolkit icon: icons/sidebar/code.svg children: + - name: AI features + children: + - name: Intelligent summaries + link: intelligent-summaries - name: CLI children: - name: Install and configure the CircleCI local CLI From 8eb18eda93fdd524dde79c963083ed5ec12846fd Mon Sep 17 00:00:00 2001 From: Rosie Yohannan Date: Wed, 10 Jul 2024 14:28:48 +0100 Subject: [PATCH 2/3] add privacy and security section --- jekyll/_cci2/intelligent-summaries.adoc | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/jekyll/_cci2/intelligent-summaries.adoc b/jekyll/_cci2/intelligent-summaries.adoc index 67d65f526b1..15977cb324c 100644 --- a/jekyll/_cci2/intelligent-summaries.adoc +++ b/jekyll/_cci2/intelligent-summaries.adoc @@ -10,13 +10,13 @@ contentTags: :icons: font :experimental: -CircleCI's intelligent summaries provide contextual help with build failures. Select btn:[Explain this error] from a failed job's step output to see an AI-generated summary of the error, along with suggestions on how to fix it. +CircleCI's intelligent summaries provide contextual help with build failures. Select btn:[Explain this error] from a failed job's step output to see an AI-generated summary of the error, along with suggestions on how to fix it. Use intelligent summaries to speed up the process of resolving common issues without needing to dig into documentation, or other resources. == Enable intelligent summaries The intelligent summaries feature is **disabled** by default. You can opt-in to the feature, as follows: -NOTE: Only organization administrators can enable or disable the feature. +NOTE: Only organization administrators can enable or disable intelligent summaries. . From the link:https://app.circleci.com/home/[CircleCI web app] select your organization card. . Select **Organization Settings** from the sidebar. @@ -25,4 +25,21 @@ NOTE: Only organization administrators can enable or disable the feature. == Use intelligent summaries +The btn:[Explain this error] button is available at the step output level in the CircleCI web app. You can locate the option by clicking through to the failed step from your link:https://app.circleci.com/home/[homepage], as follows: + +. Select your organization card from the homepage. +. Select **Pipelines** from the sidebar. +. Locate your pipeline that has a failure, and use the arrow in the **Status** column to expand the failed workflow. +. Select the name of the failed job. +. From the job view, with the **Steps** tab selected, you are viewing the step output. Locate a failed step and select btn:[Explain this error]. +. A panel appears on the right side of the screen with the intelligent summary, which includes a description of the error and steps to fix it. + +If you see a banner stating that "Intelligent Build Failures are Disabled", an organization administrator can enable the feature as outlined in <>. + == Privacy and security + +Intelligent summaries works by sending an error message along with build failure logs to a third-party LLM. Prior to submitting the error message to the LLM, CircleCI passes the message through a filter to remove any sensitive information, such as, access keys and passwords. + +OpenAI is used as the LLM for this feature. If this changes, this page will be updated to reflect the change, and there will be an announcement on our link:https://discuss.circleci.com/[community forum]. + +The data we send to the LLM is not used for training purposes and no data is saved by the LLM. No perrsonal information is sent to the LLM. \ No newline at end of file From 70d9cf39bf7cce551876c6c72fb16825ea7202e1 Mon Sep 17 00:00:00 2001 From: Rosie Yohannan Date: Mon, 15 Jul 2024 12:35:52 +0100 Subject: [PATCH 3/3] fix typo --- jekyll/_cci2/intelligent-summaries.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/jekyll/_cci2/intelligent-summaries.adoc b/jekyll/_cci2/intelligent-summaries.adoc index 15977cb324c..c90808fcf16 100644 --- a/jekyll/_cci2/intelligent-summaries.adoc +++ b/jekyll/_cci2/intelligent-summaries.adoc @@ -38,8 +38,8 @@ If you see a banner stating that "Intelligent Build Failures are Disabled", an o == Privacy and security -Intelligent summaries works by sending an error message along with build failure logs to a third-party LLM. Prior to submitting the error message to the LLM, CircleCI passes the message through a filter to remove any sensitive information, such as, access keys and passwords. +Intelligent summaries works by sending an error message along with build failure logs to a third-party LLM. Prior to submitting the error message and logs to the LLM, CircleCI passes the message through a filter to remove any sensitive information, such as, access keys and passwords. OpenAI is used as the LLM for this feature. If this changes, this page will be updated to reflect the change, and there will be an announcement on our link:https://discuss.circleci.com/[community forum]. -The data we send to the LLM is not used for training purposes and no data is saved by the LLM. No perrsonal information is sent to the LLM. \ No newline at end of file +The data we send to the LLM is not used for training purposes and no data is saved by the LLM. No personal information is sent to the LLM. \ No newline at end of file