adding documentation for the agent

docs/agent-wordlift/data-privacy-and-security.md

@@ -0,0 +1,33 @@
+---
+title: 🛡️ Data Privacy and Security
+sidebar_position: 3
+---
+
+# Our Commitment to Your Data
+
+At WordLift, we take data privacy and security very seriously. We are committed to safeguarding any data entrusted to us and have implemented robust security measures to ensure its protection.
+
+## Our Security Measures
+
+- **Secure access controls:** Each user has a dedicated, temporary workspace that stores files only during active use. These workspaces are automatically deleted after inactivity, minimizing data retention.
+- **Encryption at rest:** All data sources connected to WordLift are encrypted using the industry-standard AES-256 algorithm, including any PII (personally identifiable information) that may be detected, such as names, addresses, or social security numbers. This ensures confidentiality even if storage systems are compromised.
+
+## Our Service Provider's Data Security
+
+We partner with Microsoft, which adheres to the following data privacy principles for the Azure OpenAI Service:
+
+- **No data usage for model training:** Azure OpenAI does not use any data you submit (prompts, completions, embeddings, or training data) to train or improve its models. This ensures your data is used solely for the intended purpose within WordLift's functionalities.
+- **Limited data retention:** Azure OpenAI stores your prompts and completions for up to 30 days solely for abuse monitoring and human review. This data is deleted unless legal requirements dictate otherwise. Customers can also apply to disable abuse monitoring, in which case their data is not stored. WordLift doesn’t have access to your prompts and completions at all unless we mutually agree to do so to improve the service.
+- **Industry-standard security practices:** Azure OpenAI employs rigorous security measures, including:
+  - **Double encryption at rest:** Your data is encrypted by default with Microsoft's AES-256 and can be optionally encrypted with your key.
+  - **Limited human access:** Only authorized Microsoft personnel can access flagged data for abuse monitoring using secure methods with strict access controls.
+
+## Transparency and Access to Information
+
+We believe in transparency and empower you to access information about your data and how it is handled.
+
+- **Azure OpenAI Service data privacy:** For further details on Azure OpenAI's security measures and data usage policies, please refer to their documentation: [Azure OpenAI Data Privacy](https://learn.microsoft.com/en-us/legal/cognitive-services/openai/data-privacy)
+- **WordLift's terms of service:** Our terms of service outline our commitment to data privacy and security in greater detail. You can access them here: [WordLift Terms of Service](https://wordlift.io/terms-of-service/)
+- **WordLift’s Privacy Policy:** Other companies track your conversations to create detailed profiles about you. We developed Agent WordLift to adhere to a strict privacy policy. You can access it here: [WordLift Privacy Policy](https://wordlift.io/privacy-policy/)
+
+By choosing WordLift, you can be confident that your data is protected by industry-leading security practices and handled with the utmost care. We are committed to providing all our users with a safe and secure environment.

docs/agent-wordlift/highlights.md

@@ -0,0 +1,35 @@
+---
+title: 💫 Highlights
+sidebar_position: 2
+---
+
+## Unmatched Accuracy with Knowledge Graph
+
+Unlike traditional tools, WordLift AI SEO Agent utilizes a curated Knowledge Graph, offering deeper insights and more accurate results for data-driven SEO strategies.
+
+## Next-Gen AI with Multi-Agent Teamwork
+
+Imagine a team of experts working together to tackle your SEO challenges. Agent WordLift's neuro-symbolic AI acts like that team, using a Multi-Agent System (MAS) to combine:
+
+- **Powerful language understanding:** Analyzes vast amounts of information like a team of researchers.
+- **Multiple specialists:** Works with various "mini-experts" to handle specific tasks efficiently, similar to how a team collaborates.
+- **Seamless coordination:** All these specialists work together seamlessly, just like a well-oiled team, to deliver the best results for you.
+
+This unique approach leads to:
+
+- **Improved decision-making:** Informed recommendations based on diverse perspectives.
+- **Faster processing:** Efficient task management for quicker analysis and results.
+
+## Comprehensive Features, Simplified
+
+- **Go beyond basic SEO:** Gain a holistic understanding with features like Entity Gap Analysis and SEO Score Analysis.
+- **Effortless content creation:** Generate fresh, relevant content with Content Creation, Content Recycling, & Idea Generation.
+- **Fact-checking for trust:** Ensure content accuracy and build trust with the built-in Fact-Checking tool.
+
+## Additional Benefits
+
+- **User-friendly interface:** Easy access and use for all technical backgrounds.
+- **Scalable for growth:** Accommodates your evolving website and SEO needs.
+- **Privacy and security:** We run Agent WordLift on secure Microsoft Azure infrastructure, protecting user privacy and data security. Your conversations are safe with us – we don't track conversations for improvement, only usage data.
+
+WordLift AI SEO Agent empowers you to take your SEO efforts to the next level with its unique blend of AI, Knowledge Graph accuracy, and comprehensive, user-friendly features. We prioritize your privacy and data security, ensuring a safe and practical experience.

docs/agent-wordlift/index.md

@@ -0,0 +1,27 @@
+---
+sidebar_position: 0
+---
+
+🚀 Getting Started with WordLift AI SEO Agent
+====================================
+
+The main documentation for getting started with WordLift is organized in the following sections:
+
+## 1. Getting Started:
+
+- **Sign Up:** Head over to the WordLift website and create a free account. A payment method is required to activate the 14-day free trial.
+- **Connect Your Website:** Follow the on-screen instructions in the dashboard to connect the WordLift key to your website. This will allow the agent to analyze your website's content and structure.
+- **Build Your Knowledge Graph:** Consider building a Knowledge Graph for more comprehensive insights. This can be done manually or by leveraging WordLift's automated tools like the Product Knowledge Graph builder, the WordPress plugin, or the WordLift Cloud. A Knowledge Graph connects relevant entities and concepts related to your website's content, providing valuable context for the AI.
+
+## 2. Exploring the Agent's Functionalities:
+
+- **Set up your key:** To start using the AI SEO Agent, go to agent.wordlift.io and enter your WordLift key in the “Settings panel”.
+
+- **Explore Queries:** Uncover the hidden potential of search queries. Understand how users search for topics related to your content and discover keywords you may want to target. Start simple and ask to the SEO Agent to “analyze the query ‘semantic seo’ on google.com” or “show me the entity gap between the query ‘linked data’ and https://wordlift.io/blog/en/entity/linked-data/”
+- **Create Content:** Leverage your website content for new article creation: As mentioned, ask the Agent to “search the website for ‘the impact of blockchain technology on finance’ and using this insights, analyze the entities behind this query and create the outline for a new article.” This will allow the Agent to analyze your website's content related to blockchain and finance, analyze the entities behind the top-ranking results on Google, and use all of this information to generate a new, informative article.
+- **Expand Existing Content:** Enhance your existing content by automatically identifying and suggesting relevant entities that can be integrated seamlessly. This can improve the depth and context of your content, making it more engaging for readers and search engines. It is as simple as asking to “expand the content on https://wordlift.io/blog/en/entity/linked-data/ with entities like Google and Semantic Web”.
+
+* [Tips for using WordLift AI SEO Agent ✨](tips.md)
+* [Highlights 💫 ](highlights.md)
+* [Data Privacy and Security 🛡️ ]([data-privacy-and-security.md)
+* [Workflows 🛠️](workflows.md)

docs/agent-wordlift/tips.md

@@ -0,0 +1,16 @@
+---
+title: ✨ Tips for using WordLift AI SEO Agent
+sidebar_position: 1
+---
+
+Talk to the Agent as your SEO assistant: Provide it with step-by-step instructions.
+
+- **Watch the Video:** Get a visual introduction to the WordLift AI SEO Agent's capabilities and how it simplifies various SEO tasks.
+
+<iframe width="560" height="315" src="https://www.youtube.com/watch?v=iIwLM4dCBWY" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
+
+# Optimizing SEO with AI Agents: An Experiment
+
+- **Explore Use Cases:** Learn how different audiences, such as large organizations, editorial teams, and agencies, benefit from the WordLift AI SEO Agent's unique functionalities. Read our Use Cases.
+
+By following these steps and exploring the various features offered by the WordLift AI SEO Agent, you can effectively streamline your SEO workflow, generate data-driven insights, and create high-quality content that resonates with both users and search engines.

docs/agent-wordlift/workflows.md

@@ -0,0 +1,14 @@
+---
+title: 🛠️ Workflows
+sidebar_position: 5
+---
+
+Here is how WordLift AI SEO Agent can help you boost your productivity in different editorial workflows:
+
+- **Analyze Search Demand:**
+    - [Keyword Discovery](./workflows/keyword-discovery.md)
+- **Create Content**
+    - [Social Media](./workflows/create-social-media-posts.md)
+    - [Newsletter](./workflows/ideas-for-newsletters.md)
+- **Revamp Content**
+- [Entity Gap Analysis](./workflows/entity-gap-analysis.md)

docs/agent-wordlift/workflows/create-social-media-posts.md

@@ -0,0 +1,36 @@
+---
+title: Create social media posts using content on your website
+sidebar_position: 2
+---
+
+## Introduction
+
+Today, our goal is to create, with the help of WordLift, compelling posts for LinkedIn using the content we have on our website. In this example, we will use the agent’s multifunctional capability to perform several tasks based on a single prompt. WordLift AI SEO Agent will analyze content, extract entities, suggest keywords, and generate SEO-optimized posts for a specific audience on LinkedIn.
+
+## Writing Posts for LinkedIn
+
+We will start with a first example related to our website to write content around “neuro-symbolic AI.”
+
+### Here goes the prompt:
+
+> "Search for 'neuro-symbolic AI' and carefully analyze the writing style on my website, then extract entities and suggest keywords, and, with this in mind, write three SEO-optimized LinkedIn posts to promote the topic to a business audience in the publishing sector. Always add links back to the website to help users discover additional information."
+
+## How Things Work Behind the Scenes
+
+Using the prompt above, WordLift effectively assists you by:
+
+- **Analyzing Your Website:** It searches your website for content related to "neuro-symbolic AI" to gather relevant information and understand your writing style. This ensures the generated content aligns with your existing content and voice.
+- **Identifying Key Terms:** It analyzes keywords related to "neuro-symbolic AI" and suggests relevant search terms to enhance your LinkedIn posts. This expands your reach by including trending and related terms.
+- **Crafting Engaging Content:** It leverages the insights from the website analysis and keyword suggestions to create LinkedIn posts highlighting the innovative aspects of neuro-symbolic AI, its relevance to the publishing sector, and its benefits. These posts are designed to engage a business audience on LinkedIn and include links to your website content.
+
+Understanding these steps helps you trust the process and ensures the generated content aligns with your website's content and target audience.
+
+## Final Review
+
+Finally, we can review the key concepts behind the generated posts for LinkedIn with a new prompt:
+
+> "Draw a mind map of the key concepts behind each post."
+
+This will produce the following result.
+
+By following this workflow, you can efficiently produce targeted, SEO-optimized social media content that resonates with your audience, leveraging the comprehensive capabilities of the WordLift AI SEO Agent.

docs/agent-wordlift/workflows/entity-gap-analysis.md

@@ -0,0 +1,4 @@
+---
+title: Entity gap analyis
+sidebar_position: 4
+---

docs/agent-wordlift/workflows/ideas-for-newsletters.md

@@ -0,0 +1,20 @@
+---
+title: Ideas for the Newsletter
+sidebar_position: 3
+---
+
+# Introduction
+
+This workflow is designed to help us create a newsletter that engages the target audience and keeps them informed about a specific topic.
+
+## Generate Ideas and a First Draft
+
+To get things started, we will use this prompt:
+
+> "I'm looking for ideas on how to write engaging and informative newsletters that will keep the audience in the e-commerce space informed about structured data. Search my website, gather all the information, and present the ideas and a first draft."
+
+With this prompt, we define **e-commerce** as a target audience and **structured data** as the main topic.
+
+### Here is what we get:
+
+Within the first response, we will also receive the first draft:

docs/agent-wordlift/workflows/keyword-discovery.md

@@ -0,0 +1,36 @@
+---
+title: Run a keyword research
+sidebar_position: 1
+---
+
+# Keyword Discovery with WordLift AI SEO Agent
+
+Let’s work together on keyword research with WordLift AI SEO Agent. Keyword research provides valuable insight into how a target audience searches on Google. The insight from these queries helps us inform the content strategy and can also be applied to our day-to-day marketing efforts.
+
+## Query Analysis for Entity Extraction
+
+Let’s combine the query analysis tool to extract the main entities behind each query with keyword suggestions to identify relevant keywords and understand the context and intent behind search queries.
+
+### Example Prompt for Analyzing a Query
+
+> "Analyze the query “natural shower gel” on google.com."
+
+WordLift AI SEO Agent will now use WordLift Content Analysis to understand top-ranking results on google.com. This will shed some light on the context behind this query.
+
+## Deep Dive into Keyword Suggestions
+
+Let’s now dive deeper into keywords (how people are searching on Google) with a different prompt:
+
+> "Now, propose three keyword ideas for 'Natural Shower Gel' for each keyword, provide suggestions, extract the topics, and present all the data in a table highlighting the opportunities."
+
+This approach helps us explore the search landscape more comprehensively, identifying opportunities and understanding user intent.
+
+## Sophisticated Prompt for Blog Post Outline
+
+We can also venture into a more sophisticated prompt that will automatically run the analysis and draft the outline of a blog post:
+
+> "Now, propose three keyword ideas for 'Natural Shower Gel' for each keyword, provide suggestions, extract the topics, and present all the data in a table highlighting the opportunities. I need in the end the outline for a blog post on the keyword that has the highest chance."
+
+This prompt not only seeks keyword opportunities but also aims at creating actionable content strategy outputs, like drafting a blog post outline based on the keyword with the highest potential.
+
+By employing WordLift AI SEO Agent for keyword discovery, we can gain a competitive edge in content creation, ensuring that our strategies align with actual search behaviors and audience needs.

docs/introduction.md

@@ -13,8 +13,9 @@ This documentation was created to help users **understand and use WordLift effec
 
 In addition to providing instructions on how to use WordLift, this documentation also includes **information on related products and APIs** that developers may find useful. It includes explanations of the system's API and integration with other products, as well as details on how to use these tools to create custom solutions.
 
-This documentation is organized into the following sections: 
+This documentation is organized into the following sections:
 
+* [Agent WordLift](/agent-wordlift)
 * [WordPress plugin](/wordpress-plugin)
 * [WooCommerce SEO](/woocommerce/introduction)
 * [Google Sheets Add-on](/seo-add-on-google-sheets/introduction)