Skip to content

Commit

Permalink
final updates
Browse files Browse the repository at this point in the history
  • Loading branch information
roodboi committed Nov 27, 2024
1 parent 10880d2 commit 9f67f8c
Show file tree
Hide file tree
Showing 11 changed files with 120 additions and 32 deletions.
1 change: 1 addition & 0 deletions apps/www/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"framer-motion": "^10.12.18",
"fumadocs-core": "^14.5.4",
"fumadocs-mdx": "^11.1.2",
"fumadocs-typescript": "^3.0.2",
"fumadocs-ui": "^14.5.4",
"js-tiktoken": "^1.0.7",
"jsonwebtoken": "^9.0.2",
Expand Down
5 changes: 4 additions & 1 deletion apps/www/src/app/docs/[[...slug]]/page.tsx
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
import { notFound } from "next/navigation"
import { createTypeTable } from "fumadocs-typescript/ui"
import defaultMdxComponents from "fumadocs-ui/mdx"
import { DocsBody, DocsDescription, DocsPage, DocsTitle } from "fumadocs-ui/page"

import { metadataImage } from "@/lib/metadata"
import { source } from "@/lib/source"

const { AutoTypeTable } = createTypeTable()

export default async function Page(props: { params: Promise<{ slug?: string[] }> }) {
const params = await props.params
const page = source.getPage(params.slug)
Expand All @@ -20,7 +23,7 @@ export default async function Page(props: { params: Promise<{ slug?: string[] }>
<DocsTitle>{page.data.title}</DocsTitle>
<DocsDescription>{page.data.description}</DocsDescription>
<DocsBody>
<MDX components={{ ...defaultMdxComponents }} />
<MDX components={{ ...defaultMdxComponents, AutoTypeTable }} />
</DocsBody>
</DocsPage>
)
Expand Down
1 change: 1 addition & 0 deletions apps/www/src/content/docs/concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Concepts
---


## Partial Streaming
- **Concept**: Partial streaming in Island AI involves processing and utilizing parts of a JSON data stream as they become available. This method uses the defined Zod schema to understand the final output and stubs out the model, allowing incremental streaming of data into the JSON structure.

Expand Down
1 change: 0 additions & 1 deletion apps/www/src/content/docs/evalz/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
title: API Reference
---


### createEvaluator

Creates a basic evaluator for assessing AI-generated content based on custom criteria.
Expand Down
27 changes: 18 additions & 9 deletions apps/www/src/content/docs/evalz/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -1,20 +1,29 @@
---
title: Getting Started
---
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

## Installation

Install `evalz` using your preferred package manager:

```bash
npm install evalz openai zod @instructor-ai/instructor

bun add evalz openai zod @instructor-ai/instructor

pnpm add evalz openai zod @instructor-ai/instructor
```


<Tabs items={['bun', 'npm', 'pnpm']} persist>
<Tab value="bun">
```bash
bun add evalz openai zod @instructor-ai/instructor
```
</Tab>
<Tab value="npm">
```bash
npm install evalz openai zod @instructor-ai/instructor
```
</Tab>
<Tab value="pnpm">
```bash
pnpm add evalz openai zod @instructor-ai/instructor
```
</Tab>
</Tabs>

## Evaluator Types and Data Requirements

Expand Down
24 changes: 19 additions & 5 deletions apps/www/src/content/docs/llm-polyglot/anthropic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,30 @@
title: Anthropic
---

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

The llm-polyglot library provides support for Anthropic's API, including standard chat completions, streaming chat completions, and function calling. Both input paramaters and responses match exactly those of the OpenAI SDK - for more detailed documentation please see the OpenAI docs: [https://platform.openai.com/docs/api-reference](https://platform.openai.com/docs/api-reference)
We support Anthropic's API, including standard chat completions, streaming chat completions, and function calling. Both input paramaters and responses match exactly those of the OpenAI SDK - for more detailed documentation please see the OpenAI docs: [https://platform.openai.com/docs/api-reference](https://platform.openai.com/docs/api-reference)

The anthropic sdk is required when using the anthropic provider - we only use the types provided by the sdk.

## Installation

```bash
bun add llm-polyglot openai @anthropic-ai/sdk
```
<Tabs items={['bun', 'npm', 'pnpm']} persist>
<Tab value="bun">
```bash
bun add llm-polyglot openai @anthropic-ai/sdk
```
</Tab>
<Tab value="npm">
```bash
npm install llm-polyglot openai @anthropic-ai/sdk
```
</Tab>
<Tab value="pnpm">
```bash
pnpm add llm-polyglot openai @anthropic-ai/sdk
```
</Tab>
</Tabs>


```typescript
Expand Down
26 changes: 19 additions & 7 deletions apps/www/src/content/docs/llm-polyglot/google.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,33 @@
title: Google
---

We support Google's Gemini API including:
import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

We support Google's Gemini API including:
- standard chat completions
- streaming chat completions
- function calling
- context caching support for better token optimization (must be a paid API key)

The Google generative-ai sdk is required when using the google provider - we only use the types provided by the sdk.


## Installation

```bash
bun add llm-polyglot openai @google/generative-ai
```
<Tabs items={['bun', 'npm', 'pnpm']} persist>
<Tab value="bun">
```bash
bun add llm-polyglot openai @google/generative-ai
```
</Tab>
<Tab value="npm">
```bash
npm install llm-polyglot openai @google/generative-ai
```
</Tab>
<Tab value="pnpm">
```bash
pnpm add llm-polyglot openai @google/generative-ai
```
</Tab>
</Tabs>


#### Context Caching
Expand Down
22 changes: 19 additions & 3 deletions apps/www/src/content/docs/schema-stream/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,27 @@
title: Getting Started
---

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

## Installation

```bash
bun add schema-stream zod
```
<Tabs items={['bun', 'npm', 'pnpm']} persist>
<Tab value="bun">
```bash
bun add schema-stream zod
```
</Tab>
<Tab value="npm">
```bash
npm install schema-stream zod
```
</Tab>
<Tab value="pnpm">
```bash
pnpm add schema-stream zod
```
</Tab>
</Tabs>

## Basic Usage

Expand Down
22 changes: 19 additions & 3 deletions apps/www/src/content/docs/stream-hooks/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,27 @@
title: Getting Started
---

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

## Installation

```bash
bun add stream-hooks zod zod-stream
```
<Tabs items={['bun', 'npm', 'pnpm']} persist>
<Tab value="bun">
```bash
bun add stream-hooks zod zod-stream
```
</Tab>
<Tab value="npm">
```bash
npm install stream-hooks zod zod-stream
```
</Tab>
<Tab value="pnpm">
```bash
pnpm add stream-hooks zod zod-stream
```
</Tab>
</Tabs>

## Quick Start

Expand Down
23 changes: 20 additions & 3 deletions apps/www/src/content/docs/zod-stream/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,28 @@
title: Getting Started
---

import { Tab, Tabs } from 'fumadocs-ui/components/tabs';

## Installation

```bash
bun add zod-stream zod openai
```
<Tabs items={['bun', 'npm', 'pnpm']} persist>
<Tab value="bun">
```bash
bun add zod-stream zod openai
```
</Tab>
<Tab value="npm">
```bash
npm install zod-stream zod openai
```
</Tab>
<Tab value="pnpm">
```bash
pnpm add zod-stream zod openai
```
</Tab>
</Tabs>



## Core Concepts
Expand Down
Binary file modified bun.lockb
Binary file not shown.

0 comments on commit 9f67f8c

Please sign in to comment.