Skip to content

[Improvement] Add LLMs.txt generation #63

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/agents/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Introduction
sidebar_position: 10
description: "Overview of Weaviate AI Agents documentation for personalization, querying, and data transformation agents."
image: og/docs/agents.jpg
# tags: ['agents', 'getting started']
---
Expand Down
4 changes: 0 additions & 4 deletions docs/agents/personalization/_category_.json

This file was deleted.

1 change: 1 addition & 0 deletions docs/agents/personalization/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Personalization Agent
sidebar_position: 10
description: "Overview of the AI agent that provides personalized recommendations based on user profiles and interaction history."
image: og/docs/agents.jpg
# tags: ['agents', 'getting started', 'personalization agent']
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Build a recipe recommender with the Personalization Agent
sidebar_label: 'Tutorial: Recipe recommender'
description: Learn how to build a simple recipe recommender service with the Weaviate Personalization Agent.
description: "Tutorial for creating a recipe recommendation system using the Personalization Agent."
sidebar_position: 40
image: og/docs/tutorials.jpg
# tags: ['personalization', 'recommendation']
Expand Down
1 change: 1 addition & 0 deletions docs/agents/personalization/usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Usage
sidebar_position: 30
description: "Technical documentation and usage examples for implementing the Personalization Agent."
image: og/docs/agents.jpg
# tags: ['agents', 'getting started', 'personalization agent']
---
Expand Down
4 changes: 0 additions & 4 deletions docs/agents/query/_category_.json

This file was deleted.

1 change: 1 addition & 0 deletions docs/agents/query/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Query Agent
sidebar_position: 10
description: "Overview of the AI agent that handles complex queries across multiple Weaviate collections with natural language understanding."
image: og/docs/agents.jpg
# tags: ['agents', 'getting started', 'query agent']
---
Expand Down
2 changes: 1 addition & 1 deletion docs/agents/query/tutorial-ecommerce.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Build an E-Commerce assistant with Query Agents
sidebar_label: 'Tutorial: E-Commerce assistant'
description: Learn how to build a simple e-commerce assistant agent with the Weaviate Query Agent.
description: "Tutorial for creating an e-commerce assistant that answers product and brand queries using the Query Agent."
sidebar_position: 40
image: og/docs/tutorials.jpg
# tags: ['basics']
Expand Down
1 change: 1 addition & 0 deletions docs/agents/query/usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Usage
sidebar_position: 30
description: "Technical documentation and usage examples for implementing the Query Agent."
image: og/docs/agents.jpg
# tags: ['agents', 'getting started', 'query agent']
---
Expand Down
4 changes: 0 additions & 4 deletions docs/agents/transformation/_category_.json

This file was deleted.

1 change: 1 addition & 0 deletions docs/agents/transformation/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Transformation Agent
sidebar_position: 30
description: "Overview of the AI agent that enhances, enriches and transforms existing data in Weaviate collections."
image: og/docs/agents.jpg
# tags: ['agents', 'getting started', 'transformation agent']
---
Expand Down
28 changes: 14 additions & 14 deletions docs/agents/transformation/tutorial-enrich-dataset.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Enrich your dataset with a Transformation Agent
sidebar_label: 'Tutorial: Enrich your dataset'
description: Learn how to create additional properties in your dataset with the Weaviate Transformation Agent.
sidebar_label: "Tutorial: Enrich your dataset"
description: "Tutorial showing how to add new and update existing properties in Weaviate collections using the Transformation Agent."
sidebar_position: 40
image: og/docs/tutorials.jpg
# tags: ['basics']
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import FilteredTextBlock from '@site/src/components/Documentation/FilteredTextBlock';
import PyCode from '!!raw-loader!/docs/agents/_includes/transformation_agent_tutorial_enrich_dataset.py';
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import FilteredTextBlock from "@site/src/components/Documentation/FilteredTextBlock";
import PyCode from "!!raw-loader!/docs/agents/_includes/transformation_agent_tutorial_enrich_dataset.py";

:::caution Technical Preview

Expand All @@ -35,7 +35,7 @@ We've prepared a public dataset that you can use to explore the Transformation A

The Transformation Agent is able to access a Weaviate collection of your choosing and perform operations on the objects within it. However, each operation for the agent can be defined in natural language. The agent will then use an LLM to complete the instructions in the operation.

import WeaviateAgentsArxivFlowchart from '/docs/agents/_includes/transformation_agent_tutorial_arxiv_flowchart.png';
import WeaviateAgentsArxivFlowchart from "/docs/agents/_includes/transformation_agent_tutorial_arxiv_flowchart.png";

<div class="row">
<div class="card">
Expand Down Expand Up @@ -102,7 +102,7 @@ pip install datasets
</TabItem>
</Tabs>

import ForcePipInstall from '../_includes/_force_pip_install.mdx';
import ForcePipInstall from "../_includes/_force_pip_install.mdx";

<ForcePipInstall />

Expand All @@ -129,13 +129,13 @@ In the following code blocks, we are pulling our demo datasets from Hugging Face

### 2.1 Define the Collections

import WeaviateAgentsArxivDataset from '/docs/agents/_includes/transformation_agent_tutorial_arxiv_dataset.png';
import WeaviateAgentsArxivDataset from "/docs/agents/_includes/transformation_agent_tutorial_arxiv_dataset.png";

<div class="row">
<div class="col col--3">
<br />
<p>
In this image, you can see what the objects in the dataset{' '}
In this image, you can see what the objects in the dataset{" "}
<code>ArxivPapers</code> look like.
</p>
</div>
Expand Down Expand Up @@ -329,13 +329,13 @@ By calling `update_all()`, we get the agent to spin up individual workflows for
</TabItem>
</Tabs>

import WeaviateAgentsExplorerTool from '/docs/agents/_includes/transformation_agent_tutorial_explorer_tool.png';
import WeaviateAgentsExplorerTool from "/docs/agents/_includes/transformation_agent_tutorial_explorer_tool.png";

<div class="row">
<div class="col col--3">
<p>
Now, you can open the{' '}
<a href="https://console.weaviate.cloud/apps/explorer">Explorer tool</a>{' '}
Now, you can open the{" "}
<a href="https://console.weaviate.cloud/apps/explorer">Explorer tool</a>{" "}
to check the results of the transformation.
</p>
</div>
Expand Down Expand Up @@ -400,6 +400,6 @@ The Transformation Agent automatically interprets natural language instructions
The official changelog for Weaviate Agents can be [found here](https://weaviateagents.featurebase.app/changelog). If you have feedback, such as feature requests, bug reports or questions, please [submit them here](https://weaviateagents.featurebase.app/), where you will be able to see the status of your feedback and vote on others' feedback.
:::

import DocsFeedback from '/_includes/docs-feedback.mdx';
import DocsFeedback from "/_includes/docs-feedback.mdx";

<DocsFeedback />
1 change: 1 addition & 0 deletions docs/agents/transformation/usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Usage
sidebar_position: 30
description: "Technical documentation and usage examples for implementing the Transformation Agent."
image: og/docs/agents.jpg
# tags: ['agents', 'getting started', 'transformation agent']
---
Expand Down
4 changes: 0 additions & 4 deletions docs/cloud/embeddings/_category_.json

This file was deleted.

1 change: 1 addition & 0 deletions docs/cloud/embeddings/administration.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Administration
sidebar_position: 3
description: "Configuration and management settings for Weaviate Embeddings service at the organization level."
image: og/wcd/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/embeddings/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Weaviate Embeddings
sidebar_position: 0
description: "Managed embedding inference service that generates embeddings for data and queries directly from Weaviate Cloud."
image: og/wcd/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/embeddings/models.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Choose a model
sidebar_label: Choose a model
sidebar_position: 2
description: "List of pre-trained embedding models optimized for enterprise retrieval tasks in multiple languages."
image: og/wcd/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/embeddings/quickstart.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Quickstart
sidebar_position: 1
description: "Getting started guide for importing and querying data using the Weaviate Embeddings service."
image: og/wcd/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/faq.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: FAQs
sidebar_position: 7
description: "Frequently asked questions and answers about Weaviate Cloud (WCD) features, pricing, and troubleshooting."
image: og/wcd/faq.jpg
---

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Weaviate Cloud
sidebar_label: Introduction
description: Weaviate Cloud Services Overview
description: "Overview of Weaviate Cloud (WCD) documentation for managed vector database deployment and operations."
sidebar_position: 0
image: og/wcd/title.jpg
---
Expand Down
4 changes: 0 additions & 4 deletions docs/cloud/manage-clusters/_category_.json

This file was deleted.

1 change: 1 addition & 0 deletions docs/cloud/manage-clusters/authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Authentication
sidebar_position: 5
description: "Configure authentication options for Weaviate Cloud clusters by adding, updating and deleting API keys."
image: og/wcs/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage-clusters/authorization.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Authorization
sidebar_position: 6
description: "Role-Based Access Control (RBAC) configuration guide for Weaviate Cloud clusters."
image: og/wcs/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage-clusters/connect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Connect to Weaviate Cloud
sidebar_label: Connect to a cluster
sidebar_position: 1
description: "Multiple connection options and methods for accessing your Weaviate Cloud cluster instances."
image: og/wcs/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage-clusters/create.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Create a cluster
sidebar_position: 2
description: "Step-by-step guide to create and configure new Sandbox or Serverless Weaviate Cloud clusters."
image: og/wcd/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage-clusters/status.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Cluster status
sidebar_position: 3
description: "Monitor and check the operational status of your Weaviate Cloud clusters through multiple methods."
image: og/wcd/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage-clusters/upgrade.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Upgrade a cluster
sidebar_position: 4
description: "Manual update process for existing clusters when new Weaviate Database versions are released."
image: og/wcd/user_guides.jpg
---

Expand Down
4 changes: 0 additions & 4 deletions docs/cloud/platform/_category_.json

This file was deleted.

1 change: 1 addition & 0 deletions docs/cloud/platform/billing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Billing
sidebar_position: 3
description: "Billing information for Weaviate Cloud services, including free Sandbox clusters and paid Serverless plans."
image: og/wcd/user_guides.jpg
---

Expand Down
1 change: 1 addition & 0 deletions docs/cloud/platform/create-account.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: Create a user account
sidebar_position: 20
description: "Account creation process for accessing Weaviate Cloud console."
image: og/wcd/user_guides.jpg
---

Expand Down
Loading
Loading