Skip to content

Commit

Permalink
re enrich docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mozedz committed Jul 26, 2023
1 parent c951c79 commit 86fbecf
Show file tree
Hide file tree
Showing 13 changed files with 144 additions and 80 deletions.
2 changes: 1 addition & 1 deletion docs/common/company/assets.md
Expand Up @@ -10,7 +10,7 @@ They include:
* Variants of our "g" logo
* Typography
* Brand Colors
* Variants of [Doggo the Kagi Mascot](mascot.md)
* Variants of [Doggo the Kagi Mascot](../about-kagi/kagi-mascot.md)

## Orion Browser

Expand Down
40 changes: 38 additions & 2 deletions docs/kagi/ai/summarize-page.md
@@ -1,10 +1,18 @@
# Summarize Page
Summarize Page (or Universal Summarizer as it's also called) is a way to summarize any page, video og podcast (given a transcript).

There are three ways to summarize a page:
There are currently four ways to summarize a page:

1. Directly in the search results
2. Via bang
3. On a dedicated page, independent of a previous search
3. Via API
4. On a dedicated page, independent of a previous search

All, apart from the API, are free for every paid Kagi user.

Summarize Page is made using Kagi's own, in-house models. There are currently two models in use:
1. Agnes (accessable via either the web or the API)
2. Muriel (currently API only)

## In search results

Expand All @@ -22,6 +30,34 @@ After reading the summary you can even choose to proceed to [Discuss this docume

Quickly summarize any page using the [bang `!sum`](../features/bangs.md#universal-summarizer).

## Via API
See [Summarizer API](../api/summarizer.md) for more details.

As mentioned at the start, two models are offered in the API. As for the differences between the two AI models, here is them summarizing the same [document](https://arxiv.org/pdf/2112.11446.pdf).

**Agnes:**

> The PDF document titled “Scaling Language Models: Methods, Analysis & Insights from Training Gopher” presents an analysis of Transformer-based language model performance across a wide range of model scales, from models with tens of millions of parameters up to a 280 billion parameter model called Gopher. The models are evaluated on 152 diverse tasks, achieving state-of-the-art performance across the majority. The study finds that gains from scale are largest in areas such as reading comprehension, fact-checking, and the identification of toxic language, but logical and mathematical reasoning see less benefit. The document also provides a holistic analysis of the training dataset and models behavior, covering the intersection of model scale with bias and toxicity. Finally, the study discusses the application of language models to AI safety and the mitigation of downstream harms. The key implication of this study is that larger language models can significantly improve performance on a wide range of natural language processing tasks, but there are also concerns about the potential for bias and toxicity in these models.
> The paper also provides a holistic analysis of the training dataset and the model’s behavior, examining the intersection of model scale with bias and toxicity. It discusses the application of language models to AI safety and the mitigation of downstream harms.
**Muriel:**

> This PDF document presents an analysis of Transformer-based language model performance across various scales, focusing on a 280 billion parameter model called Gopher. The models are evaluated on 152 diverse tasks, achieving state-of-the-art performance in the majority of them. The most significant gains from scaling are observed in areas such as reading comprehension, fact-checking, and toxic language identification, while logical and mathematical reasoning see less benefit.
>
> The paper also provides a holistic analysis of the training dataset and the model’s behavior, examining the intersection of model scale with bias and toxicity. It discusses the application of language models to AI safety and the mitigation of downstream harms.
>
> Key findings include:
> 1. Gopher outperforms current state-of-the-art language models in approximately 81% of tasks with comparable results, particularly in knowledge-intensive domains such as fact-checking and general knowledge.
> 2. Larger models are more likely to generate toxic responses when provided with toxic prompts, but they can also more accurately classify toxicity.
> 3. Gains from scale are largest in areas like reading comprehension, fact-checking, and the identification of toxic language. However, logical and mathematical reasoning see less benefit.
>
> The document also discusses challenges and future directions, such as:
> 1. Towards efficient architectures: The need for more efficient architectures to reduce the computational cost of training and inference.
> 2. Challenges in toxicity and bias: Addressing the issues of toxicity and bias in language models to ensure safe and fair AI systems.
> 3. Safety benefits and risks: Balancing the potential benefits of language models in AI safety with the risks associated with their misuse.
>
> In conclusion, the paper highlights the improved performance of large-scale language models like Gopher in various tasks and emphasizes the importance of addressing challenges related to toxicity, bias, and AI safety.
## Universal Summarizer landing page

There's <https://kagi.com/summarizer> where you can enter the URL of any page, PDF, PPTX, MP3, video etc that you want to have summarized.
Expand Down
4 changes: 1 addition & 3 deletions docs/kagi/api/enrich.md
Expand Up @@ -4,8 +4,7 @@ The enrichment APIs are a collection of indexes that can be used to supplement o

They are best used for finding non-commerical websites and "small web" discussions surrounding a particular topic. The news enrichment API offers interesting discussions and news worth reading from typically non-mainstream sources.

They are not "general" search indexes that can answer any type of query but rather these results are our 'secret sauce' and what makes Kagi results unique and interesting.

They are not "general" search indexes that can answer any type of query but rather these results are our 'secret sauce' and what makes Kagi results unique and interesting.

## Pricing

Expand Down Expand Up @@ -458,4 +457,3 @@ curl -v \
```

</details>

15 changes: 11 additions & 4 deletions docs/kagi/api/overview.md
Expand Up @@ -5,16 +5,23 @@ results & more.

## Kagi APIs

- [Search API](search.md)
- [Universal Summarizer API](summarizer.md)
- [FastGPT](fastgpt.md)
We have the following APIs available.

- [Universal Summarizer API](summarizer.md) (public)
- [FastGPT API](fastgpt.md) (public)
- [Search API](search.md) (invite only at the moment)

Quick start for all APIs:

1. Get the [API key](https://kagi.com/settings?p=api) (requires a Kagi account).
2. Top off your [API credits](https://kagi.com/settings?p=billing_api).
3. Call the API.

## Unofficial Client Libraries

Libraries created by Kagi users and third parties.

- [kagigo for Go - FastGPT & Universal Summarizer](https://github.com/httpjamesm/kagigo)
- [FastGPT for Raycast](https://www.raycast.com/http.james/kagi-fastgpt)

## Beta Status

Expand Down
2 changes: 1 addition & 1 deletion docs/kagi/features/code.md
Expand Up @@ -2,7 +2,7 @@

Kagi supports developers with code samples in response to search results.

For example, consider searching for *write!*
For example, consider searching for <i>write!</i>

<img src="./media/initial_write_search.png" alt="Write Search No Filter">

Expand Down
10 changes: 9 additions & 1 deletion docs/kagi/features/website-info-personalized-results.md
@@ -1,6 +1,6 @@
# Website Info & Personalized Results

To the right of each Kagi search result is a Crystal Ball icon. Hovering over the icon or tapping it will access additional features related to the webpage for that result.
To the right of each Kagi search result is a shield icon. Hovering over the icon or tapping it will access additional features related to the webpage for that result.

<img src="./media/crystal_ball.png" width="675" alt="Crystal Ball Icon">

Expand Down Expand Up @@ -31,6 +31,14 @@ Your options are to:

You can see your Personalized Results for all websites in [Settings](https://kagi.com/settings?p=user_ranked).

## Personalization Leaderboard

Wonder what domains are the most popular among Kagi users to modify the rankings of? Check the [Personalization Leaderboard](https://kagi.com/settings?p=rule_leaderboard). We aggregrate the rankings of domains that have been tagged by othe
r Kagi users.


<img src="https://kagifeedback.org/assets/files/2023-07-01/1688193924-891326-image.png" width="675" alt="Personalization leaderboard"><br />

## Website Information

At the bottom of the information window for the search result is useful data about the website for the result.
Expand Down
80 changes: 34 additions & 46 deletions docs/kagi/getting-started/index.md
@@ -1,67 +1,55 @@
# Quick Start

## Table of Contents

- [Signing Up](#signing-up)
- [Basic Searches](#basic-searches)
- [Filter Search Results](#filter-search-results)
- [Using Search Operators](#using-search-operators)
- [Bang Searches](#bang-searches)
- [Lens Searches](#lens-searches)
- [Personalized Results](#personalized-results)

## Signing Up

Before you can use Kagi, you need to visit [https://kagi.com](https://kagi.com) and sign up for a [**Free Basic** or **Premium**](../plans/plan-types.md) plan.

## Basic Searches

To do a basic search, simply visit [https://kagi.com](https://kagi.com) and search for something.
Kagi helps you find exactly what you're looking for online. It has a few more capabilities than the search engine you're used to so let's explore how to get the most out of them.

<img src="./media/basic_search.gif" width="675" alt="Basic Search"><br />

Or, if you've [set Kagi as your default search engine](setting-default.md), you can do a search from your browser's address bar.

## Filter Search Results

You can [filter](../features/filtering-results.md) your search results to focus on the results you most care about.

<img src="./media/options.gif" width="675" alt="Filter Options Button"><br />

<img src="./media/filters.gif" width="675" alt="Filtering Results"><br />
## Table of Contents

## Using Search Operators
- [Personalize Results](#personalize-results)
- [Summarize Results](#summarize-results)
- [Summarize Page](#summarize-page)
- [Refining Search Results](#refining-search-results)
- [Sharing Search Results](#sharing-search-results)

If you press **?** on your keyboard (**shift + /**) while in search results, Kagi will open a scrollable window showing keyboard shortcuts, search operators, query shortcuts, and widgets. You can also click or tap **Help** at the bottom of any Kagi webpage to see the same information.
## Personalize Results

<img src="./media/search_operators.jpeg" width="675" alt="Search Operators"><br />
Kagi's personalization options lets you customize your results including eliminating websites that you find low quality or distracting or boosting those that you find more useful. Clicking the shield icon to the right of a search result reveals additional information and [personalization options](https://help.kagi.com/kagi/features/website-info-personalized-results.html) for that result. From here you can raise or lower the weighting for that website including blocking websites that you'd like eliminated from your search results. You can see some of the more popular modifications on the [Kagi Personalization Leaderboard](https://kagi.com/settings?p=rule_leaderboard).

For example, searching for [outfit movie !](https://kagi.com/search?q=outfit%20movie%20!) will take you straight to the first result for that query.
<img src="./media/personalize_results.png" width="675" alt="Personalize Results"><br />
<br />
<br />

<img src="./media/search_operator.gif" width="675" alt="Search Operator Example"><br />
## Summarize Results (Quick Answer)<a id='summarize-results'></a>

You can read [documentation](../features/search-operators.md) that covers the search operators in detail.
Quick Answer (aka [Summarize Results](https://help.kagi.com/kagi/ai/summarize-results.html)) extracts and summarizes the important content from the search results including links to the source material.

## Bang Searches
<img src="./media/summarize_results.png" width="675" alt="Summarize Results"><br />
<br />
<br />

Kagi supports all DuckDuckGo-style [bangs](../features/bangs.md). Bangs are shortcuts starting with exclamation points (!) that quickly take you to search results on other sites.
## Summarize Page

For example, searching Kagi for **!w Monty Python** will search Wikipedia directly for "Monty Python" and take you to that Wikipedia search result.
Clicking the three dot icon next to a search result brings up page options. [Summarize Page](https://help.kagi.com/kagi/ai/summarize-page.html) provides a synopsis of the page.

<img src="./media/bang.gif" width="675" alt="Bang Example"><br />
<img src="./media/summarize_page.png" width="675" alt="Summarize Page"><br />
<br />
<br />

## Lens Searches
## Refining Search Results

Kagi [Lenses](../features/lenses.md) allow you to customize your searches by specifying which websites (and other parameters) you see in your results. We provide a few Lenses to get you started, such as one to search only online discussions and forums. You can also create your own!
Just below the search box you can quickly filter for the types of results such as Images or Podcasts or you can use [Kagi Lenses.](https://help.kagi.com/kagi/features/lenses.html) Lenses are search filters and rules applied to search results. Built-in Lenses include Forums (results from the thousands of specialized online communities as well as Reddit), Academic (results from academic institutions), and Programming (coding forums and websites) and more. Custom Lenses can be created as well.

Here's an example using the built-in EDU lens:
<img src="./media/kagi_lenses.png" width="675" alt="Kagi Lenses"><br />
<br />
<br />

<img src="./media/lens.gif" width="675" alt="Lens Example"><br />
You can also use [Search operators ](https://help.kagi.com/kagi/features/search-operators.html) to tune your results. For instance the filetype: operator can limit results to specific filetypes. E.g. adding “filetype:xlsx” to your query will limit your results to only Microsoft Excel files. A quick reference of search operators is available from anywhere on kagi.com by typing “?” [Note: make sure you’re not typing into a form or text box when entering “?” to bring up the reference window.]

## Personalized Results
<img src="./media/search_operators.png" width="675" alt="Search operators reference"><br />
<br />
<br />

You can tweak how the website for a result is treated in future Kagi searches using [Personalized Results](../features/website-info-personalized-results.md#personalized_results).
## Sharing Search Results

<img src="./media/personalized_results.gif" width="675" alt="Personalized Results Example"><br />
You can [share your search results](https://help.kagi.com/kagi/features/share-results.html) with friends who may not be Kagi subscribers by using the “Share This Search” button at the bottom of a search result page or by selecting More > Share This Search. This will copy a link to your clipboard which you can pass on to others.

You can see your Personalized Results for all websites in [Settings](https://kagi.com/settings?p=user_ranked).
<img src="./media/share_this_search.png" width="675" alt="Sharing Search Results"><br />
11 changes: 9 additions & 2 deletions docs/kagi/getting-started/setting-default.md
Expand Up @@ -2,6 +2,7 @@

## Table of Contents

- [Option 0: Use Orion browser by Kagi (currently for macOS/iOS only)](#orion)
- [Option 1: Using the Kagi Browser Extension](#browser_extension)
- [Access to Safari Browsing History](#safari_extension)
- [Note for Brave Browser Users](#brave_extension)
Expand All @@ -19,8 +20,15 @@
- [Custom Use](#custom_use)
- [Private Session](#private_session)

<a name="browser_extension"></a>

<a name="orion"></a>
## Option 0: Use Orion browser by Kagi (currently for macOS/iOS only)

If you use Apple devices with macOS/iOS/iPadOS you can use Orion browser by Kagi. It has Kagi built-in and is the easiest option to start using Kagi.

[Download Orion](https://browser.kagi.com).

<a name="browser_extension"></a>
## Option 1: Using the Kagi Browser Extension

Kagi is available as an extension for all major browsers. The extension sets Kagi as the default search engine and allows you to search with Kagi even in a private window.
Expand Down Expand Up @@ -180,4 +188,3 @@ The session link will include a special token that will allow you to log into Ka
- Open a new tab and navigate to https://kagi.com and submit a search
- Open your browser’s settings. Choose Search engine.
- Select Kagi from the Recently Visited section.

4 changes: 1 addition & 3 deletions docs/kagi/search-details/search-sources.md
Expand Up @@ -4,10 +4,8 @@ We use heuristics and deep learning to understand query intent, select the best

You can think of Kagi as a "search client," working like an email client, connecting to indexes and sources to find relevant results and package them into a superior, secure, and privacy-respecting search experience.

Our searching includes anonymized requests to traditional search indexes like Google and Bing and vertical sources like Wikipedia, DeepL, and other APIs. We also have our own non-commercial index (Teclis), news index (TinyGem), and an AI for instant answers.
Our searching includes anonymized requests to traditional search indexes like Google and [Mojeek](https://mojeek.com), niche search engines like [Marginalia](https://search.marginalia.nu) and vertical sources like Wikipedia, Open Meteo, and other APIs. We also have our own web index (Teclis), news index (TinyGem), and an AI for instant answers.

Teclis and TinyGem are a result of our crawl through millions of domains, focusing primarily on non-commercial, high-quality content. Our unique results help you discover the best content you can possibly find online, sometimes from the quieter places on the web.

And, of course, we answer quick queries like "How far is the sun from the earth?" or "10kg in lbs" with our instant-answer systems that use dozens of sources and APIs, all connected to you quickly yet transparently.

If Kagi gets results from Google or Bing, it does not display paid/sponsored results. Kagi only shows the organic results to your anonymized queries.

0 comments on commit 86fbecf

Please sign in to comment.