From b56cf09c83afce868ab065c409f1d5a11779da16 Mon Sep 17 00:00:00 2001 From: cyberandy Date: Mon, 18 Mar 2024 10:08:09 +0100 Subject: [PATCH] updating docs --- docs/agent-wordlift/faq.md | 5 ++++ docs/introduction.md | 2 +- .../index.md => knowledge-graph/botify.md} | 8 ++++--- docs/knowledge-graph/index.md | 7 ++++-- docusaurus.config.js | 24 +++++++++---------- 5 files changed, 28 insertions(+), 18 deletions(-) create mode 100644 docs/agent-wordlift/faq.md rename docs/{api-guides/botify/index.md => knowledge-graph/botify.md} (97%) diff --git a/docs/agent-wordlift/faq.md b/docs/agent-wordlift/faq.md new file mode 100644 index 0000000..1c0401c --- /dev/null +++ b/docs/agent-wordlift/faq.md @@ -0,0 +1,5 @@ +--- +sidebar_position: 8 +--- + +## Frequently Asked Questions diff --git a/docs/introduction.md b/docs/introduction.md index 5a068d5..d403667 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -18,7 +18,7 @@ This documentation is organized into the following sections: * **Search Demand** * [Google Sheets Add-on](/seo-add-on-google-sheets/introduction) * **Knowledge Graph** - * [Botify Connector](/api-guides/botify) + * [Botify Connector](/knowledge-graph/botify/) * [Sitemap Import](/knowledge-graph/sitemap-import/) * [Analytics Import](/knowledge-graph/analytics-api/) * [Product Knowledge Graph Builder](/product-knowledge-graph-builder/introduction/) diff --git a/docs/api-guides/botify/index.md b/docs/knowledge-graph/botify.md similarity index 97% rename from docs/api-guides/botify/index.md rename to docs/knowledge-graph/botify.md index 40b5cfa..868b332 100644 --- a/docs/api-guides/botify/index.md +++ b/docs/knowledge-graph/botify.md @@ -1,8 +1,10 @@ --- -title: Botify Crawl Imports +sidebar_position: 40 +toc_min_heading_level: 2 +toc_max_heading_level: 5 --- -# Botify +# Botify Crawl Imports Use the Botify Crawl Imports endpoint (`https://api.wordlift.io/botify-crawl-imports`) to populate a Knowledge Graph with data from Botify. @@ -72,7 +74,7 @@ With this request we tell the API to: 1. Use the Botify collection called `crawl.20240127`. 1. Filter the data by the field `crawl.20240127.extract.plp_header_description_extracted_text_part_1`. The Botify filters can be used here. 1. We ask the API to generate embeddings by using the resulting `headline` and `text` properties from the schema.org namespace. -1. We tell the API to generate the `text` property by joining the data present in the `{collection}.extract.plp_header_description_extracted_text_part_...` Botify property. +1. We tell the API to generate the `text` property by joining the data present in the `{collection}.extract.plp_header_description_extracted_text_part_...` Botify property. :::tip `{collection}` is a placeholder, it is replaced with the value set in `collection`. diff --git a/docs/knowledge-graph/index.md b/docs/knowledge-graph/index.md index 7137ccd..4763195 100644 --- a/docs/knowledge-graph/index.md +++ b/docs/knowledge-graph/index.md @@ -8,6 +8,9 @@ The Knowledge Graph constitutes the basic representation of the Knowledge Domain There are several way to populate data in a Knowledge Graph. -In this section you can populate data using URLs by providing a `sitemap.xml` file or manually by using the [Sitemap Import API](./sitemap-import.md). +In this section you can populate data using: -Once the web pages have been imported it is possible to populate the Analytics data by using the [Analytics API](./analytics-api.md). \ No newline at end of file +- URLs by providing a `sitemap.xml` file or manually by using the [Sitemap Import API](./sitemap-import.md) or; +- Crawl data coming from [Botify](./botify.md) + +Once the web pages have been imported it is possible to populate the Analytics data by using the [Analytics API](./analytics-api.md). This requires access to Google Search Console and might not be needed if you are using the [Botify Crawl Import](botify.md). \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index e0898b1..fd6b645 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -76,18 +76,18 @@ const config = { label: "Products", position: "left", items: [ - { label: "Search Demand > Google Sheets Add-on", to: "seo-add-on-google-sheets/introduction" }, - { label: "Knowledge Graph > Botify Connector", to: "api-guides/botify" }, - { label: "Knowledge Graph > Sitemap Import", to: "knowledge-graph/sitemap-import/" }, - { label: "Knowledge Graph > Analytics Import", to: "knowledge-graph/analytics-api/" }, - { label: "Knowledge Graph > Product Knowledge Graph Builder", to: "product-knowledge-graph-builder/introduction" }, - { label: "Knowledge Graph > WordPress Plugin", to: "wordpress-plugin" }, - { label: "Knowledge Graph > WooCommerce Plugin", to: "woocommerce/introduction" }, - { label: "Knowledge Graph > Cloud", to: "cloud" }, - { label: "Smart Content > Agent WordLift", to: "agent-wordlift" }, - { label: "Smart Content > Content Generation", to: "content-generation" }, - { label: "Smart Content > LLM Connectors", to: "llm-connectors/wordlift-reader" }, - { label: "Semantic Reporting > Looker Studio Connector ", to: "looker-studio-connector/introduction" }, + { label: "Search Demand / Google Sheets Add-on", to: "seo-add-on-google-sheets/introduction" }, + { label: "Knowledge Graph / Botify Connector", to: "knowledge-graph/botify/" }, + { label: "Knowledge Graph / Sitemap Import", to: "knowledge-graph/sitemap-import/" }, + { label: "Knowledge Graph / Analytics Import", to: "knowledge-graph/analytics-api/" }, + { label: "Knowledge Graph / Product Knowledge Graph Builder", to: "product-knowledge-graph-builder/introduction" }, + { label: "Knowledge Graph / WordPress Plugin", to: "wordpress-plugin" }, + { label: "Knowledge Graph / WooCommerce Plugin", to: "woocommerce/introduction" }, + { label: "Knowledge Graph / Cloud", to: "cloud" }, + { label: "Smart Content / Agent WordLift", to: "agent-wordlift" }, + { label: "Smart Content / Content Generation", to: "content-generation" }, + { label: "Smart Content / LLM Connectors", to: "llm-connectors/wordlift-reader" }, + { label: "Semantic Reporting / Looker Studio Connector ", to: "looker-studio-connector/introduction" }, ], }, {