Skip to content

Commit

Permalink
Update introduction and add new use case topic (#74)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
pwoznic committed Aug 23, 2023
1 parent 6755d05 commit 9974874
Show file tree
Hide file tree
Showing 6 changed files with 218 additions and 5 deletions.
6 changes: 6 additions & 0 deletions www/docs/api-reference/auth-apis/api-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 6 additions & 0 deletions www/docs/api-reference/auth-apis/oauth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions www/docs/common-use-cases/app-authn-authz/create_api_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
124 changes: 124 additions & 0 deletions www/docs/use-case-exploration.md
Original file line number Diff line number Diff line change
@@ -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 <Config v="names.product"/> 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 <Config v="names.product"/> 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. <Config v="names.product"/> also provides result recommendations and enables global
collaboration through its **cross-language** search.


## Vectara GenAI Use Cases

This versatile <Config v="names.product"/> GenAI platform caters to a wide range of use
cases to drive better outcomes and unlock new possibilities in search
applications. <Config v="names.product"/> provides an easy entry point to generative AI
capabilities while protecting company IP and customer data. The data
is secure. <Config v="names.product"/> 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 <Config v="names.product"/> 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 <Config v="names.product"/> 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. <Config v="names.product"/> 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 <Config v="names.product"/> 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. <Config v="names.product"/> 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 <Config v="names.product"/> 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 <Config v="names.product"/>'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 <Config v="names.product"/> GenAI conversational search.

:::note

These sample applications are examples of our platform in action and not supported products.

:::

73 changes: 69 additions & 4 deletions www/docs/welcome.md
Original file line number Diff line number Diff line change
@@ -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 <Config v="names.product"/>'s documentation homepage. Choose a topic on the left to learn more.
Welcome to the documentation homepage for <Config v="names.product"/>, an end-to-end platform for
product builders to embed powerful generative AI capabilities into
applications with extraordinary results. <Config v="names.product"/> offers significant
improvements over traditional searches by understanding the context and
meaning of your data. This revolutionary technology enables <Config v="names.product"/> to
drive insights and provide more accurate responses to user queries,
assisting decision-making processes. User data remains secure because <Config v="names.product"/>
never trains on customer data.

## The Future of Search is Here

The <Config v="names.product"/> team envisions a future where generative AI powers every
application to deliver contextually accurate responses and give the right
answers and actions. <Config v="names.product"/> 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. <Config v="names.product"/>
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. <Config v="names.product"/> provides the best hybrid search
core and superior language understanding for ingestion and retrieval. <Config v="names.product"/>
can become your answer engine.

## Developer-focused, API-first, Secure

Designed for developers with an API-first approach, <Config v="names.product"/> 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 <Config v="names.product"/> Generative AI platform enables
developers with the flexibility to build a [wide range of applications](/docs/use-case-exploration) with
powerful search experiences.

The <Config v="names.product"/> platform never trains on customer data which enables
businesses to embed generative AI capabilities without the risk of data or
privacy violations. <Config v="names.product"/> 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 <Config v="names.product"/> addresses
this problem through **Grounded Generation**, meaning it grounds the search
results in the uploaded data. By focusing on facts and reducing
hallucinations, <Config v="names.product"/> enhances trust in AI-powered decision making.

## Language Agnostic

Use <Config v="names.product"/> 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 <Config v="names.product"/> 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. <Config v="names.product"/> 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 <Config v="names.product"/> 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
Expand Down
8 changes: 7 additions & 1 deletion www/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit 9974874

Please sign in to comment.