diff --git a/www/docs/api-reference/rest.md b/www/docs/api-reference/rest.md index 8995a3096..0d79fcdd3 100644 --- a/www/docs/api-reference/rest.md +++ b/www/docs/api-reference/rest.md @@ -40,7 +40,7 @@ RESTful structure. All APIs are authenticated. Indexing and Search APIs can be authenticated via [API Keys](/docs/learn/authentication/api-key-management). The Personal API Key enables most Admin actions for creating and deleting -corpora, but for deleting accounts and accessing billing data, you need to use +corpora, but for deleting accounts and accessing usage data, you need to use [OAuth 2.0](/docs/learn/authentication/oauth-2). ## API Reference and OpenAPI specifications diff --git a/www/docs/console-ui/manage-usage.md b/www/docs/console-ui/manage-usage.md new file mode 100644 index 000000000..cdc0f45cb --- /dev/null +++ b/www/docs/console-ui/manage-usage.md @@ -0,0 +1,46 @@ +--- +id: manage-usage +title: Manage Usage +sidebar_label: Manage Usage +--- + +import CodePanel from '@site/src/theme/CodePanel'; + +The Usage page provides a single place to track plan quotas, current +consumption, and any charges for the selected period. Use it to understand +how close you are to plan limits and to plan capacity before workloads are +impacted. For the latest information on Vectara plans, such as comparisons and +FAQs, see our [Pricing](https://www.vectara.com/pricing) page. + +1. Access the [Vectara Console](https://console.vectara.com/console). +2. Select the [**Usage**](https://console.vectara.com/console/usage/resource-usage) tab. + +At the top of the page you’ll see the reporting window, for example: + +**Period from 05‑Aug‑2025 to 31‑Aug‑2025** + +Usage numbers reflect activity within this window. Resource usage numbers +might be delayed by up to four hours. + +## Resource usage + +The table summarizes each tracked resource with its current usage, plan base +quota, and percentage consumed: + +### Data storage +Shows used storage out of your plan base quota (like 119.2 of 100 MB). + +### GPT‑4 generative requests +Counts generative API calls against the plan base quota (like 12,853 of +20,000 requests). The percentage used appears beneath the count. + +### Corpora +Tracks how many corpora are provisioned with a percentage used. + +### Users +Tracks the number of users provisioned in your tenant with a percentage used. + +:::tip +When a metric approaches its limit, consider archiving unused data, reducing +request volume, or working with your admin to adjust plan capacity. +::: \ No newline at end of file diff --git a/www/docs/console-ui/personal_api_key.md b/www/docs/console-ui/personal_api_key.md index 43949b71d..b4e625df7 100644 --- a/www/docs/console-ui/personal_api_key.md +++ b/www/docs/console-ui/personal_api_key.md @@ -42,7 +42,7 @@ limitations and **do not** let you perform the following tasks: * Delete a Vectara account * Validate a Vectara account registration * Transfer account ownership -* Read or set any sensitive billing data such as payment method and addresses +* Read or set any sensitive data such as payment method and addresses * Create and delete users OAuth 2.0 remains the required method for these operations due to its advanced diff --git a/www/docs/console-ui/vectara-console-overview.md b/www/docs/console-ui/vectara-console-overview.md index dfda41913..1b8817cfb 100644 --- a/www/docs/console-ui/vectara-console-overview.md +++ b/www/docs/console-ui/vectara-console-overview.md @@ -10,22 +10,21 @@ import CodePanel from '@site/src/theme/CodePanel'; The Vectara Console enables you to create corpora, manage data and API access, add team members, build API requests, and manage your Vectara account: -- :rocket: **Five-Minute Walkthrough:** Let Vectara show you [how to build a simple +- :rocket: **Five-minute walkthrough:** Let Vectara show you [how to build a simple GenAI application](https://console.vectara.com/console/walkthrough) in just a few minutes! -- :runner: **Get Started Quickly:** View our [Quick Start guide](/docs/quickstart) and search the Vectara +- :runner: **Get started quickly:** View our [Quick Start guide](/docs/quickstart) and search the Vectara Employee Handbook PDF. -- :floppy_disk: **Manage Corpora:** [Create and manage your corpora data](/docs/console-ui/creating-a-corpus), which serve as storage +- :floppy_disk: **Manage corpora:** [Create and manage your corpora data](/docs/console-ui/creating-a-corpus), which serve as storage for data that you want to search. -- :ledger: **Manage Data:** Manage the data in your account. -- :closed_lock_with_key: **Manage API Access:** Users can define API access credentials, including +- :ledger: **Manage data:** Manage the data in your account. +- :closed_lock_with_key: **Manage API access:** Users can define API access credentials, including [API Keys](/docs/learn/authentication/api-key-management) and [OAuth app clients](/docs/learn/authentication/oauth-2). -- :busts_in_silhouette: **Invite Team Members:** [Add users to your team](/docs/console-ui/manage-user) and assign +- :busts_in_silhouette: **Invite team members:** [Add users to your team](/docs/console-ui/manage-user) and assign specific permissions for each user. -- :wrench: **Build API Requests:** Create API requests within the console and copy-paste +- :wrench: **Build API requests:** Create API requests within the console and copy-paste into your code. -- :moneybag: **Manage Billing Details:** View account usage information and [payment - details](/docs/console-ui/update-credit-card) to ensure uninterrupted service. -- :globe_with_meridians: **Vectara Platform Overview:** Learn about the Vectara Platform and view interactive +- :moneybag: **View usage details:** View account usage information to understand how close you are to plan quotas. +- :globe_with_meridians: **Vectara platform overview:** Learn about the Vectara Platform and view interactive parts of our documentation like the [API Reference](/docs/rest-api/vectara-rest-api-v-2). ## Vectara Console home page diff --git a/www/docs/learn/authentication/api-key-management.md b/www/docs/learn/authentication/api-key-management.md index aa71feeef..ba016ed30 100644 --- a/www/docs/learn/authentication/api-key-management.md +++ b/www/docs/learn/authentication/api-key-management.md @@ -70,7 +70,7 @@ for accessible corpora, reading usage data, updating corpora filters, executing queries, and indexing. **Unsupported actions:** Deleting an account, validating a registration, -transferring account ownership, deleting users, or accessing billing data. +transferring account ownership, deleting users, or accessing account usage data. :::caution A Personal API Key inherits the permissions of its associated user account. @@ -95,7 +95,7 @@ API Keys and should be treated like passwords and used with caution in production environments. :::important -In terms of billing, account owners are responsible for charges incurred +In terms of usage, account owners are responsible for charges incurred through anonymous access to your account with any of these API keys. ::: diff --git a/www/docs/learn/authentication/multi-tenant-corpus-isolation.md b/www/docs/learn/authentication/multi-tenant-corpus-isolation.md index 9fcc97045..fb5dc680b 100644 --- a/www/docs/learn/authentication/multi-tenant-corpus-isolation.md +++ b/www/docs/learn/authentication/multi-tenant-corpus-isolation.md @@ -27,7 +27,7 @@ security, predictable access patterns, and simplified troubleshooting. | Hard security boundary | API keys are only valid for specific corpora | | No need for metadata filters | Access enforcement is at the platform level | | Tenant self-service readiness | Easier to automate onboarding and offboarding | -| Per-tenant billing & monitoring | Enables per-corpus usage tracking | +| Per-tenant usage & monitoring | Enables per-corpus usage tracking | ## Best practices @@ -82,7 +82,7 @@ Any request using a key tied only to `acme_docs` cannot access other corpora. |----------------------------------|------------------------------------| | Self-contained customer app | Per-corpus API keys | | Dedicated user dashboards | App backend maps user → corpus | -| Customer billing per data use | One corpus = one billing unit | +| Customer data use | One corpus = one usage unit | ## When not to use corpus isolation diff --git a/www/docs/learn/authentication/vectara-personas-and-access-patterns.md b/www/docs/learn/authentication/vectara-personas-and-access-patterns.md index 024d24097..88242355b 100644 --- a/www/docs/learn/authentication/vectara-personas-and-access-patterns.md +++ b/www/docs/learn/authentication/vectara-personas-and-access-patterns.md @@ -138,7 +138,7 @@ developers, admins, and other team members. - **Account Admin**: Manages account settings, users, and all corpora. - **Corpus Admin**: Manages specific corpora, including creating, querying, and indexing. - - **Billing Admin**: Handles billing and subscription tasks. + - **Billing Admin**: Handles platform usage and subscription tasks. 2. **Scope API Keys**: Assign QueryService (`zqt_`) or IndexService (`zwt_`) API keys to developers for corpus-specific access, simulating group-like permissions without native group creation. diff --git a/www/sidebars.ts b/www/sidebars.ts index 25887e755..de92a7c36 100644 --- a/www/sidebars.ts +++ b/www/sidebars.ts @@ -302,9 +302,12 @@ const sidebars: SidebarsConfig = { { type: "category", label: "Manage Queries", + link: { + type: 'doc', + id: "console-ui/configure-queries", + }, collapsed: true, items: [ - "console-ui/configure-queries", "console-ui/evaluate-queries", ], }, @@ -316,18 +319,24 @@ const sidebars: SidebarsConfig = { { type: "category", label: "Manage Conversations", + link: { + type: 'doc', + id: "console-ui/vectara-chat-overview", + }, collapsed: true, items: [ - "console-ui/vectara-chat-overview", "console-ui/chat-with-your-data", ], }, { type: "category", label: "Manage API Authorization", + link: { + type: 'doc', + id: "console-ui/api-access-overview", + }, collapsed: true, items: [ - "console-ui/api-access-overview", "console-ui/personal-api-key", "console-ui/index-and-query-api-keys", "console-ui/app-clients", @@ -336,12 +345,12 @@ const sidebars: SidebarsConfig = { { type: "doc", id: "console-ui/manage-user", - label: "Manage Users", + label: "Manage Team Members", }, { type: "doc", - id: "console-ui/update-credit-card", - label: "Manage Payments", + id: "console-ui/manage-usage", + label: "Manage Usage", }, "console-ui/delete-account", ],