Skip to content

Commit

Permalink
WCD Explorer Tool docs (#2908)
Browse files Browse the repository at this point in the history
* Explorer tool doc draft

* Add pagination section

* Add callout styling to text

* Update img

* Add refresh button note

* Update serverless wording

* Fix nomenclature re serverless/enterprise saas
  • Loading branch information
databyjp authored Jan 8, 2025
1 parent 8f75675 commit e64c4e5
Show file tree
Hide file tree
Showing 15 changed files with 180 additions and 13 deletions.
4 changes: 2 additions & 2 deletions _includes/wcs/support-and-troubleshoot.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
For help with [Serverless](/developers/wcs#serverless), [Enterprise SaaS](/developers/wcs#weaviate-enterprise-saas), and [Bring Your Own Cloud](/developers/wcs#bring-your-own-cloud) accounts, contact [Weaviate support](mailto:[email protected]) directly to open a support ticket.
For help with [Serverless Cloud](/developers/wcs#serverless-cloud), [Enterprise Cloud](/developers/wcs#weaviate-enterprise-cloud), and [Bring Your Own Cloud](/developers/wcs#bring-your-own-cloud) accounts, contact [Weaviate support](mailto:[email protected]) directly to open a support ticket.

For questions and support from the Weaviate community, try these resources:

- [Community forum](https://forum.weaviate.io)
- [GitHub](https://github.com/weaviate/weaviate)
- [Slack](https://weaviate.io/slack)

To add a support plan, contact [Weaviate sales](https://weaviate.io/pricing#contact-sales).
To add a support plan, contact [Weaviate sales](https://weaviate.io/pricing#contact-sales).
10 changes: 5 additions & 5 deletions _includes/wcs/wcs-landing-solutions.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
WCD offers three types of cloud hosting:

- [Serverless](#serverless)
- [Weaviate Enterprise SaaS](#weaviate-enterprise-saas)
- [Serverless](#serverless-cloud)
- [Weaviate Enterprise Cloud](#weaviate-enterprise-cloud)
- [Bring Your Own Cloud](#bring-your-own-cloud)

[Contact our sales team](https://weaviate.io/pricing#contact-sales) to discuss which solution is right for you.

### Serverless
### Serverless Cloud

- WCD manages a serverless SaaS deployment.
- Storage pricing is based on the vectors and objects you store.
- Compute costs follow a consumption model.
- Multiple SLA tiers are available.

### Weaviate Enterprise SaaS
### Weaviate Enterprise Cloud

- WCD manages an instance for you in the Weaviate Cloud.
- Pricing is based on the host cluster.
Expand All @@ -25,4 +25,4 @@ WCD offers three types of cloud hosting:

- Weaviate manages the data plane and you manage your VPC.
- Weaviate provides 24/7 support, monitoring, and troubleshooting.
- Pricing is based on CPU and RAM utilization.
- Pricing is based on CPU and RAM utilization.
2 changes: 1 addition & 1 deletion blog/2023-12-12-aws-reinvent/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Weaviate is an open-source vector database, built from the ground up for vector
- **Native multi-tenancy support**: ensure your users’ data doesn’t merge together.
- **Built-in hybrid search**: customize the weighting of the bm25 and vector search method with the `alpha` value.
- **Robust integration library**: connect Weaviate to your AI stack of choice including providers like Amazon Sagemaker, OpenAI, Cohere, and Hugging Face through our modular architecture.
- **Flexible deployment options**: run Weaviate locally or as a managed service (Serverless, Weaviate Enterprise SaaS, or Bring Your Own Cloud) depending on your business needs.
- **Flexible deployment options**: run Weaviate locally or as a managed service (Serverless, Weaviate Enterprise Cloud, or Bring Your Own Cloud) depending on your business needs.

**What is Weaviate Vector Club?**

Expand Down
Binary file added developers/wcs/img/explorer-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added developers/wcs/img/explorer-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added developers/wcs/img/explorer-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added developers/wcs/img/explorer-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added developers/wcs/img/explorer-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added developers/wcs/img/explorer-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added developers/wcs/img/explorer-7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions developers/wcs/platform/support-levels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ sidebar_position: 5

Sandboxes and self-hosted clusters are not eligible for paid support.

Paid support is available for Serverless Clusters, Weaviate Enterprise SaaS, and Bring your Own Cloud clusters.
Paid support is available for Serverless Clusters, Weaviate Enterprise Cloud, and Bring your Own Cloud clusters.

- For Serverless instances, the default support level is Standard support. You are automatically enrolled for Standard support when you create a Serverless cluster. To switch to another level, contact our [sales team](https://weaviate.io/pricing#contact-sales)

- For Weaviate Enterprise SaaS and Bring your Own Cloud clusters, contact our [sales team](https://weaviate.io/pricing#contact-sales) to discuss which level of support is right for you.
- For Weaviate Enterprise Cloud and Bring your Own Cloud clusters, contact our [sales team](https://weaviate.io/pricing#contact-sales) to discuss which level of support is right for you.

### Standard support

Expand Down Expand Up @@ -98,4 +98,4 @@ import SupportAndTrouble from '/_includes/wcs/support-and-troubleshoot.mdx';

import CustomScriptLoader from '/src/components/scriptSwitch';

<CustomScriptLoader/>
<CustomScriptLoader/>
152 changes: 152 additions & 0 deletions developers/wcs/tools/explorer-tool.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
---
title: Explorer tool
sidebar_position: 30
image: og/wcs/user_guides.jpg
---

The *Explorer* tool provides a graphical interface for inspecting your Weaviate instance that is connected to Weaviate Cloud. Browse collections, examine objects, and inspect metadata and vectors - all without writing code.

## Navigating the Interface

The Explorer tool is organized hierarchically, guiding you from clusters down to individual objects. Follow these steps to navigate through your data.

### Select a cluster

import ExplorerImg1 from '/developers/wcs/img/explorer-1.png';
import ExplorerImg2 from '/developers/wcs/img/explorer-2.png';

<div class="row">
<div class="card">
<div class="card__image">
<img src={ExplorerImg1} alt="Explorer Tool"/>
</div>
<div class="card__body">
<p>To begin, select the <code>Explorer</code> tool from the left-hand menu as shown below (item <span class="callout">1</span>).</p>
</div>
</div>
</div>
<br/>

<div class="row">
<div class="card">
<div class="card__image">
<img src={ExplorerImg2} alt="Explorer Tool"/>
</div>
<div class="card__body">
<p>This will load a list of available clusters (item <span class="callout">2</span>). Select a cluster from the list (item <span class="callout">3</span>) to view the collections and objects within that cluster.</p>
</div>
</div>
</div>
<br/>

### Explore collections and objects

Once you've selected a cluster, you can dive into your [collections](/developers/weaviate/concepts/data.md#collections) and examine its [objects](/developers/weaviate/concepts/data.md#data-object-concepts).

import ExplorerImg3 from '/developers/wcs/img/explorer-3.png';
import ExplorerImg4 from '/developers/wcs/img/explorer-4.png';
import ExplorerImg5 from '/developers/wcs/img/explorer-5.png';

<div class="row">
<div class="card">
<div class="card__image">
<img src={ExplorerImg3} alt="Explorer Tool"/>
</div>
<div class="card__body">
<p>Selecting a cluster shows a list of available collections (item <span class="callout">4</span>). Select a collection (item <span class="callout">5</span>) to view its objects.</p>
</div>
</div>
</div>
<br/>

#### Examining Objects

When you select a collection, Explorer displays its objects in an easy-to-read format. Each object is shown with its:

- Unique identifier (UUID)
- Properties and their values
- Metadata (expandable)
- Vector embeddings

Some details are initially shown as collapsed. Click on the color-coded property group to expand and view the details.

<div class="row">
<div class="card">
<div class="card__image">
<img src={ExplorerImg4} alt="Explorer Tool"/>
</div>
<div class="card__body">
<p>Objects in the selected collection is shown (item <span class="callout">6</span>) as a list of objects. </p>
<br/>
<p>Each object is listed with its unique ID and its properties (item <span class="callout">7</span>), including the property name and value. Hover over the property name as (item <span class="callout">7a</span>) to see the property type.</p>
</div>
</div>
</div>
<br/>

<div class="row">
<div class="card">
<div class="card__image">
<img src={ExplorerImg5} alt="Explorer Tool"/>
</div>
<div class="card__body">
<p>Click on the color-coded property group such as metadata (item <span class="callout">8</span>) or vectors (item <span class="callout">9</span>) to expand collapsed details.</p>
<br/>
<p>Vectors are shown initially by its name where <a href="/developers/weaviate/concepts/data#multiple-vectors-named-vectors">named vectors</a> are used and number of dimensions. Expand the item further to see some of the vectors, or click `copy` (item <span class="callout">10</span>) to copy the entire vector to clipboard.</p>
</div>
</div>
</div>
<br/>

### View as JSON

Explorer offers both a structured view and a raw JSON format.

Toggle between the standard formatted view and JSON view for any object:

- Click the `{}` icon to switch to JSON view
- Click again to return to the formatted view
- The JSON view shows the complete object structure, including all nested properties, metadata, and vectors

import ExplorerImg6 from '/developers/wcs/img/explorer-6.png';

<div class="row">
<div class="card">
<div class="card__image">
<img src={ExplorerImg6} alt="Explorer Tool"/>
</div>
<div class="card__body">
<p>View an object in JSON format (item <span class="callout">11</span>) by clicking the <code>{}</code> icon (item <span class="callout">12</span>). Return to the object view by clicking the same icon again.</p>
</div>
</div>
</div>
<br/>

### Pagination & Refresh

When viewing a collection with many objects, pagination controls are available at the bottom of the list. Use these controls to navigate through the objects.

Additionally, the refresh button at the top of the page allows you to update the list of objects in the collection.

import ExplorerImg7 from '/developers/wcs/img/explorer-7.png';

<div class="row">
<div class="card">
<div class="card__image">
<img src={ExplorerImg7} alt="Explorer Tool"/>
</div>
<div class="card__body">
<p>When viewing a collection with many objects, pagination controls (item <span class="callout">13</span>) are available at the bottom of the list. Use these controls to navigate through the objects.</p>
<br/>
<p>The number of objects per page can be adjusted using the dropdown (item <span class="callout">14</span>), where the total number of objects in the collection is also shown.</p>
<br/>
<p>The "refresh" button (item <span class="callout">15</span>) at the top right of the page allows you to update the list of objects in the collection.</p>
</div>
</div>
</div>

## Support

import SupportAndTrouble from '/_includes/wcs/support-and-troubleshoot.mdx';

<SupportAndTrouble />
2 changes: 1 addition & 1 deletion src/components/Pricing/FAQ/faq.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
"answer": "AIUs are currently only applicable to Weaviate Enterprise Cloud. In the future, we will introduce AIU pricing to Weaviate Serverless Cloud."
},
{
"question": "Will Weaviate Serverless Support AIUs?",
"question": "Will Weaviate Serverless Cloud Support AIUs?",
"answer": "AIUs are currently only applicable to Weaviate Enterprise Cloud. In the future, we will introduce AIU pricing to Weaviate Serverless Cloud."
},
{
Expand Down
2 changes: 1 addition & 1 deletion src/components/Service/Serverless/Integrations/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default function Integrations() {
<h3>Start building today</h3>
<p>
Our developer-approved resources will help you get started quickly
with Weaviate Serverless. And our team and community are here for
with Weaviate Serverless Cloud. And our team and community are here for
support as you need us.
</p>
<div className={styles.iconsContainer}>
Expand Down
15 changes: 15 additions & 0 deletions src/css/blog-and-docs.scss
Original file line number Diff line number Diff line change
Expand Up @@ -220,3 +220,18 @@ a.navbar__item.navbar__link[href='/developers/weaviate/api/rest'] {
margin-right: auto;
width: 30%;
}

.callout {
display: inline-flex;
align-items: center;
justify-content: center;
width: 20px;
height: 20px;
border-radius: 50%;
background-color: white;
border: 2px solid #61bd73;
color: black;
font-size: 12px;
font-weight: 500;
margin: 0 2px;
}

0 comments on commit e64c4e5

Please sign in to comment.