From 9974874dae7ecb3ccfe1fc035ac74c0025f1bb3c Mon Sep 17 00:00:00 2001 From: Paul Wozniczka <25128922+pwoznic@users.noreply.github.com> Date: Tue, 22 Aug 2023 20:11:57 -0500 Subject: [PATCH] Update introduction and add new use case topic (#74) * Update About URL and add link to Vectara's Discord channel. Update the About link to correct the 404 error. Then add a Social Media link to Vectara's Discord channel. * Update file_upload.md Add doc_meta example and update curl command syntax with single quotes around URL * Update file_upload.md Update doc_metadata example * Update file_upload.md Fix example for doc_meta * Update indexing topics Updated a few statements based on team discussion around indexing * Update spacing 80 char spacing * Add warning about keeping keys and tokens private Users need to be careful so that they do not accidentally share their keys or tokens in public channels. I added this note to three topics that discuss API keys and OAuth tokens. * Update spacing Updated spacing to resolve conflict * Update introduction and add new topic Update information about the Vectara platform along with information about common use cases Update sidebar to reflect changes * Update margins and variables Fixed margins ~80 chars --- www/docs/api-reference/auth-apis/api-keys.md | 6 + www/docs/api-reference/auth-apis/oauth.md | 6 + .../app-authn-authz/create_api_keys.md | 6 + www/docs/use-case-exploration.md | 124 ++++++++++++++++++ www/docs/welcome.md | 73 ++++++++++- www/sidebars.js | 8 +- 6 files changed, 218 insertions(+), 5 deletions(-) create mode 100644 www/docs/use-case-exploration.md diff --git a/www/docs/api-reference/auth-apis/api-keys.md b/www/docs/api-reference/auth-apis/api-keys.md index 76847e5cd..3fae4b0fe 100644 --- a/www/docs/api-reference/auth-apis/api-keys.md +++ b/www/docs/api-reference/auth-apis/api-keys.md @@ -16,6 +16,12 @@ having an accidental publication of an over-privileged API key is often organizationally "expensive." In general, it's recommended that you use [OAuth 2.0](OAuth 2.0) if/where possible for production applications. +:::warning + +:lock: Always keep your API Keys and 0Auth tokens private. Do not share them through email, Slack, Discord, forums, or other public channels because it can lead to unauthorized access. Treat these keys with the same confidentiality as your personal credentials. + +::: + # Use an API Key To use an API key in a request, you need to pass in `x-api-key` as an HTTP header. diff --git a/www/docs/api-reference/auth-apis/oauth.md b/www/docs/api-reference/auth-apis/oauth.md index d3122e200..c30bd0242 100644 --- a/www/docs/api-reference/auth-apis/oauth.md +++ b/www/docs/api-reference/auth-apis/oauth.md @@ -22,6 +22,12 @@ OAuth 2.0 has several advantages over API keys or simple usernames/passwords: - OAuth 2.0 is inherently more tightly scoped than API keys - JWT tokens are detected by many security scanning tools, allowing them to more easily be flagged in the case of accidental publication +:::warning + +:lock: Always keep your OAuth tokens private. Do not share them through email, Slack, Discord, forums, or other public channels because it can lead to unauthorized access. Treat these tokens with the same confidentiality as your personal credentials. + +::: + # Creating an application client Go to [https://console.vectara.com/console/authentication/app-client](https://console.vectara.com/console/authentication/app-client) to create a new application client. Most applications will want to use the diff --git a/www/docs/common-use-cases/app-authn-authz/create_api_keys.md b/www/docs/common-use-cases/app-authn-authz/create_api_keys.md index 9be00bf1f..872851806 100644 --- a/www/docs/common-use-cases/app-authn-authz/create_api_keys.md +++ b/www/docs/common-use-cases/app-authn-authz/create_api_keys.md @@ -45,6 +45,12 @@ using the it. Then, click **Create**. You can now start using the key. +:::warning + +:lock: Always keep your API Keys and OAuth tokens private. Do not share them through email, Slack, Discord, forums, or other public channels because it can lead to unauthorized access. Treat these keys with the same confidentiality as your personal credentials. + +::: + ## Using a Key To use an API key, pass it using the `x-api-key` header request. diff --git a/www/docs/use-case-exploration.md b/www/docs/use-case-exploration.md new file mode 100644 index 000000000..adae3f2e2 --- /dev/null +++ b/www/docs/use-case-exploration.md @@ -0,0 +1,124 @@ +--- +id: use-case-exploration +title: Explore the Vectara Use Cases +sidebar_label: Use Case Exploration +--- + +import {Config} from './definitions.md'; + +The AI era has changed interactions between people and information +dramatically. Users expect relevant answers to questions in a natural +language, and they expect the best results with the right context. +Using gives you relevant results no matter how you ask. Our +conversational search platform generates summarized responses that speak your +language. Better results enable better outcomes that reduce support costs and +improve the customer experience. + +## Why Vectara? Get Answers and Better Outcomes + +The platform has a unique ability to understand and process +information. Our platform uses **hybrid search** to find the most relevant +products, support cases, and documents that answer your user’s questions first. +Power chatbots, Q&A systems, conversational applications and websites that base +their information on what you and your users care about – information grounded +in facts. also provides result recommendations and enables global +collaboration through its **cross-language** search. + + +## Vectara GenAI Use Cases + +This versatile GenAI platform caters to a wide range of use +cases to drive better outcomes and unlock new possibilities in search +applications. provides an easy entry point to generative AI +capabilities while protecting company IP and customer data. The data +is secure. does not train on user data and respects data +sovereignty and provides you with peace of mind. + +:bulb: Check out [example Vectara applications, demos, and tutorials](http://vectara.com/demos/) to explore the many capabilities of our platform. + +### Conversational AI + +Use to leverage the power of intelligent chatbots that provide +an interactive user experience. Enable your users with self-service as they engage in +human-like interactions, providing context in queries, and receiving +intelligent answers because the system understands them. This technology +sits behind virtual assistants, chatbots, and messaging applications to +help businesses automate customer service and streamline operations. + +Vectara enables you to empower users with real-time feedback to avoid +escalations and build a digital chat agent that can deflect support +calls. Making conversational AI easier to use increases both customer +satisfaction and engagement. + + +### Question and Answering + +Vectara understands the context of a question and provides accurate, relevant +responses. The advantage lets users ask complex questions to get +precise answers that save your team valuable time and resources. + +Enable your users to ask a question and get the precise answers quickly. Embed +your FAQs, customer support interactions, product manuals, inform knowledge +workers on data, and enhance your website search. empowers your +organization to create a dynamic, responsive, and continuous improving Question +and Answer system that enhances the user experience and provides context-aware answers. + + +### Research and Analysis + +Vectara sifts through volumes of publications, news articles, financial reports, +scientific and medical research, corporate documents and more and provides +summarized answers to guide decision-making in your domain. Collaborate with +researchers to streamline the peer review process by investigating topics and +questions in these vast volumes of data to identify key insights. + +Using is like having a global research assistant that can read and +understand large volumes of documents in an instant. Let the platform speed up +your research process, find the most relevant information, and become a +recommendation system for your domain. + +Vectara can help transform data into insights which help make decision-making +easier. This platform can provide hidden insights and patterns from your data, +helping you make informed decisions. Not only can it answer your questions, +but also provides citations grounded in facts from the raw data. + + +### Semantic App Search + +Vectara lets you embed powerful hybrid search into your applications without +being an LLM expert. You provide data and queries through simple APIs in +our SaaS service. + +Enable your users to find the most relevant products, support cases, and +documents that answer their questions. helps you bridge the gap +between user queries and the vast amount of data within an application. +Users can find exactly what they are looking for despite how they ask. + +## Sample Vectara Demos and Applications + +We provide this list of sample applications to help inspire developer +creativity: + +* [**AskNews**](https://asknews.demo.vectara.com) + + Demonstrates the power of GenAI conversational search. Ask questions about news + events around the world and get accurate answers thanks to 's Grounded + Generation. +* [**Vectara Ingest**](https://github.com/vectara/vectara-ingest) + + Crawl datasets from pre-built crawlers (websites, RSS feeds, Jira, Notion, + Docusaurus) and ingest them into Vectara +* [**Vectara Answer**](https://github.com/vectara/vectara-answer) + + Enable users to create custom conversational search applications, such as + chatbots, semantic search, and workplace search by connecting to your + ingested data. + + This project provides example code for a modern user-interface for GenAI conversational search. + +:::note + +These sample applications are examples of our platform in action and not supported products. + +::: + diff --git a/www/docs/welcome.md b/www/docs/welcome.md index 537f8c8b3..627946548 100644 --- a/www/docs/welcome.md +++ b/www/docs/welcome.md @@ -1,16 +1,81 @@ --- id: introduction slug: / -title: Welcome to Vectara -sidebar_label: Introduction +title: What is the Vectara Platform? +sidebar_label: The Vectara Platform --- import {Config} from './definitions.md'; -You've reached 's documentation homepage. Choose a topic on the left to learn more. +Welcome to the documentation homepage for , an end-to-end platform for +product builders to embed powerful generative AI capabilities into +applications with extraordinary results. offers significant +improvements over traditional searches by understanding the context and +meaning of your data. This revolutionary technology enables to +drive insights and provide more accurate responses to user queries, +assisting decision-making processes. User data remains secure because +never trains on customer data. + +## The Future of Search is Here + +The team envisions a future where generative AI powers every +application to deliver contextually accurate responses and give the right +answers and actions. is built on a solid **hybrid search** core +to enable better generative outcomes. Traditional search technologies focus +on keywords, which limit their ability to understand complex queries. +deploys advanced **zero-shot** models and **conversational search** +capabilities to understand, interpret, and respond to user queries with remarkable +precision. + +Vectara summarizes search results on complex queries while providing factual +citations from your data. provides the best hybrid search +core and superior language understanding for ingestion and retrieval. +can become your answer engine. + +## Developer-focused, API-first, Secure + +Designed for developers with an API-first approach, is +the optimal choice to **integrate generative AI search** into your +applications. This complete end-to-end platform provides easy ingestion and +simple APIs. The Generative AI platform enables +developers with the flexibility to build a [wide range of applications](/docs/use-case-exploration) with +powerful search experiences. + +The platform never trains on customer data which enables +businesses to embed generative AI capabilities without the risk of data or +privacy violations. provides support for customer-managed +keys, encryption at rest and during transit, client-configurable data +retention, and more. + +## Solve the Hallucination Problem + +AI content generators often create **hallucinations** – false information +outside of the raw, factual data - they make stuff up. These hallucinations +lead to inaccurate and misleading responses addresses +this problem through **Grounded Generation**, meaning it grounds the search +results in the uploaded data. By focusing on facts and reducing +hallucinations, enhances trust in AI-powered decision making. + +## Language Agnostic + +Use to search across multiple languages, eliminating language +barriers and enabling users to find what they need, regardless of the +language they use. This **cross-language** approach provides a seamless +search experience for users around the world. The best answer may be +written in German but a user asked the question in Spanish. + +The platform is more than just an AI product. It is +a pioneer in the realm of **neural search**, leading the way to harness the +power of your data. wants to transform the way +developers interact with data and unlock a world of insights at their +fingertips. Welcome to the future of information interaction! + +### Not sure where to start? + +Here are some ideas: -Not sure where to start? Here are some ideas: - If you don't have a account yet, register for one [here](https://console.vectara.com/signup) +- Check out some [Vectara applications, demos, and video tutorials](https://vectara.com/demos/) - Have a look at examples of how to [index](/docs/getting-started-samples/rest_index_document.py) and [search](/docs/getting-started-samples/rest_query.py) documents - Grab the [full protobuf definitions](/docs/api-reference/protobuf-definitions) and start building using gRPC diff --git a/www/sidebars.js b/www/sidebars.js index 7bacd4e13..5c426bd6d 100644 --- a/www/sidebars.js +++ b/www/sidebars.js @@ -2,7 +2,13 @@ module.exports = { someSidebar: [ { type: 'doc', - id: 'introduction' + id: 'introduction', + label: "The Vectara Platform", + }, + { + type: 'doc', + id: 'use-case-exploration', + label: "Use Case Exploration", }, { type: 'category',