From c01502fb8460aee4350481035a5d224b3aa807a8 Mon Sep 17 00:00:00 2001
From: Alex Yang <himself65@outlook.com>
Date: Thu, 31 Oct 2024 14:02:31 -0700
Subject: [PATCH] docs: update document (#1418)
---
apps/next/src/app/docs/[[...slug]]/page.tsx | 11 +++++-
.../llamaindex/Integration/lang-trace.mdx | 39 +++++++++++++++++++
.../docs/llamaindex/Integration/meta.json | 5 +++
.../llamaindex/Integration/open-llm-metry.mdx | 34 ++++++++++++++++
.../llamaindex/{readers => loading}/index.mdx | 0
.../content/docs/llamaindex/loading/meta.json | 5 +++
.../src/content/docs/llamaindex/meta.json | 3 +-
.../content/docs/llamaindex/readers/meta.json | 5 ---
.../docs/llamaindex/setup/getting-started.mdx | 4 +-
9 files changed, 97 insertions(+), 9 deletions(-)
create mode 100644 apps/next/src/content/docs/llamaindex/Integration/lang-trace.mdx
create mode 100644 apps/next/src/content/docs/llamaindex/Integration/meta.json
create mode 100644 apps/next/src/content/docs/llamaindex/Integration/open-llm-metry.mdx
rename apps/next/src/content/docs/llamaindex/{readers => loading}/index.mdx (100%)
create mode 100644 apps/next/src/content/docs/llamaindex/loading/meta.json
delete mode 100644 apps/next/src/content/docs/llamaindex/readers/meta.json
diff --git a/apps/next/src/app/docs/[[...slug]]/page.tsx b/apps/next/src/app/docs/[[...slug]]/page.tsx
index c784a3f2e..9602aef75 100644
--- a/apps/next/src/app/docs/[[...slug]]/page.tsx
+++ b/apps/next/src/app/docs/[[...slug]]/page.tsx
@@ -20,7 +20,16 @@ export default async function Page(props: {
const MDX = page.data.body;
return (
- <DocsPage toc={page.data.toc} full={page.data.full}>
+ <DocsPage
+ toc={page.data.toc}
+ full={page.data.full}
+ editOnGithub={{
+ owner: "run-llama",
+ repo: "LlamaIndexTS",
+ sha: "main",
+ path: `apps/next/src/content/docs/${page.file.path}`,
+ }}
+ >
<DocsTitle>{page.data.title}</DocsTitle>
<DocsDescription>{page.data.description}</DocsDescription>
<DocsBody>
diff --git a/apps/next/src/content/docs/llamaindex/Integration/lang-trace.mdx b/apps/next/src/content/docs/llamaindex/Integration/lang-trace.mdx
new file mode 100644
index 000000000..a95001829
--- /dev/null
+++ b/apps/next/src/content/docs/llamaindex/Integration/lang-trace.mdx
@@ -0,0 +1,39 @@
+---
+title: Langtrace
+description: Learn how to integrate LlamaIndex.TS with Langtrace.
+---
+import { Tab, Tabs } from "fumadocs-ui/components/tabs";
+
+Enhance your observability with Langtrace, a robust open-source tool supports OpenTelemetry and is designed to trace, evaluate, and manage LLM applications seamlessly. Langtrace integrates directly with LlamaIndex, offering detailed, real-time insights into performance metrics such as accuracy, evaluations, and latency.
+
+## Install
+
+- Self-host or sign-up and generate an API key using [Langtrace](https://www.langtrace.ai) Cloud
+
+<Tabs groupId="install-langtrase" items={["npm", "yarn", "pnpm"]} persist>
+ ```shell tab="npm"
+ npm install @langtrase/typescript-sdk
+ ```
+
+ ```shell tab="yarn"
+ yarn add @langtrase/typescript-sdk
+ ```
+
+ ```shell tab="pnpm"
+ pnpm add @langtrase/typescript-sdk
+ ```
+</Tabs>
+
+## Initialize
+
+```js
+import * as Langtrace from "@langtrase/typescript-sdk";
+Langtrace.init({ api_key: "<YOUR_API_KEY>" });
+```
+
+Features:
+
+- OpenTelemetry compliant, ensuring broad compatibility with observability platforms.
+- Provides comprehensive logs and detailed traces of all components.
+- Real-time monitoring of accuracy, evaluations, usage, costs, and latency.
+- For more configuration options and details, visit [Langtrace Docs](https://docs.langtrace.ai/introduction).
diff --git a/apps/next/src/content/docs/llamaindex/Integration/meta.json b/apps/next/src/content/docs/llamaindex/Integration/meta.json
new file mode 100644
index 000000000..2d671d4fa
--- /dev/null
+++ b/apps/next/src/content/docs/llamaindex/Integration/meta.json
@@ -0,0 +1,5 @@
+{
+ "title": "Integration",
+ "description": "See our integrations",
+ "pages": ["open-llm-metry", "lang-trace"]
+}
diff --git a/apps/next/src/content/docs/llamaindex/Integration/open-llm-metry.mdx b/apps/next/src/content/docs/llamaindex/Integration/open-llm-metry.mdx
new file mode 100644
index 000000000..001ce0e24
--- /dev/null
+++ b/apps/next/src/content/docs/llamaindex/Integration/open-llm-metry.mdx
@@ -0,0 +1,34 @@
+---
+title: OpenLLMetry
+description: Learn how to integrate LlamaIndex.TS with OpenLLMetry.
+---
+import { Tab, Tabs } from "fumadocs-ui/components/tabs";
+
+[OpenLLMetry](https://github.com/traceloop/openllmetry-js) is an open-source project based on OpenTelemetry for tracing and monitoring
+LLM applications. It connects to [all major observability platforms](https://www.traceloop.com/docs/openllmetry/integrations/introduction) and installs in minutes.
+
+### Usage Pattern
+
+
+<Tabs groupId="install-traceloop" items={["npm", "yarn", "pnpm"]} persist>
+ ```shell tab="npm"
+ npm install @traceloop/node-server-sdk
+ ```
+
+ ```shell tab="yarn"
+ yarn add @traceloop/node-server-sdk
+ ```
+
+ ```shell tab="pnpm"
+ pnpm add @traceloop/node-server-sdk
+ ```
+</Tabs>
+
+```js
+import * as traceloop from "@traceloop/node-server-sdk";
+
+traceloop.initialize({
+ apiKey: process.env.TRACELOOP_API_KEY,
+ disableBatch: true
+});
+```
\ No newline at end of file
diff --git a/apps/next/src/content/docs/llamaindex/readers/index.mdx b/apps/next/src/content/docs/llamaindex/loading/index.mdx
similarity index 100%
rename from apps/next/src/content/docs/llamaindex/readers/index.mdx
rename to apps/next/src/content/docs/llamaindex/loading/index.mdx
diff --git a/apps/next/src/content/docs/llamaindex/loading/meta.json b/apps/next/src/content/docs/llamaindex/loading/meta.json
new file mode 100644
index 000000000..ef3bbec67
--- /dev/null
+++ b/apps/next/src/content/docs/llamaindex/loading/meta.json
@@ -0,0 +1,5 @@
+{
+ "title": "Loading Data",
+ "description": "Loading Data using LlamaIndex.TS",
+ "pages": ["index"]
+}
diff --git a/apps/next/src/content/docs/llamaindex/meta.json b/apps/next/src/content/docs/llamaindex/meta.json
index 967d9b076..81b31a2ac 100644
--- a/apps/next/src/content/docs/llamaindex/meta.json
+++ b/apps/next/src/content/docs/llamaindex/meta.json
@@ -8,6 +8,7 @@
"index",
"setup",
"starter",
- "readers"
+ "loading",
+ "Integration"
]
}
diff --git a/apps/next/src/content/docs/llamaindex/readers/meta.json b/apps/next/src/content/docs/llamaindex/readers/meta.json
deleted file mode 100644
index fb42b41ce..000000000
--- a/apps/next/src/content/docs/llamaindex/readers/meta.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "title": "Loading",
- "description": "File Readers Collection",
- "pages": ["index"]
-}
diff --git a/apps/next/src/content/docs/llamaindex/setup/getting-started.mdx b/apps/next/src/content/docs/llamaindex/setup/getting-started.mdx
index 180a37c01..f65880d92 100644
--- a/apps/next/src/content/docs/llamaindex/setup/getting-started.mdx
+++ b/apps/next/src/content/docs/llamaindex/setup/getting-started.mdx
@@ -20,7 +20,7 @@ import {
<>
<SiTypescript className="inline" color="#3178C6" /> TypeScript
</>
- } href="/docs/llamaindex/setup/typescript.mdx" />
+ } href="/docs/llamaindex/setup/typescript" />
<Card title={
<>
<SiVite className='inline' color='#646CFF' /> Vite
@@ -29,7 +29,7 @@ import {
<Card
title={
<>
- <SiNextdotjs className='inline' color='#000000' /> Next.js (React Server Component)
+ <SiNextdotjs className='inline' /> Next.js (React Server Component)
</>
}
href="/docs/llamaindex/setup/next"
--
GitLab