(chore): update links to /docs

traceloop · Apr 9, 2024 · 46330e6 · 46330e6
1 parent c9e0884
commit 46330e6
Show file tree

Hide file tree

Showing 21 changed files with 1,941 additions and 5 deletions.
diff --git a/fern/definition/gdpr-privacy.yml b/fern/definition/gdpr-privacy.yml
@@ -0,0 +1,83 @@
+docs: |
+
+service:
+  base-path: '/api/config/privacy'
+  auth: true
+  endpoints:
+    delete:
+      display-name: Delete specific user data
+      docs: |
+        
+        You can delete traces data for a specific user of yours by specifying their association properties.
+      path: "/data-deletion"
+      method: DELETE
+      request: DeleteUserData
+      response: DeleteUserDataResponse
+      examples:
+        - request: $DeleteUserData.ExampleDeleteUserData
+          response: 
+            body: $DeleteUserDataResponse.ExampleDeleteUserDataResponse
+    get:
+      display-name: Status of user deletion request
+      docs: |
+        By default, all prompts and responses are logged. 
+
+        If you’ve disabled this behavior by following [this guide](/docs/openllmetry/privacy/prompts-completions-and-embeddings), and then selectively enabled it for some of your users, then you can use this API to view which users you’ve enabled.
+      path: "/data-deletion"
+      request:
+        name: GetDeletionStatusRequest
+        query-parameters:
+          requestId: 
+            type: string
+            docs: |
+
+              The request ID from the user deletion request.
+      method: GET
+      response: GetDeletionStatusResponse
+
+types:
+
+  DeleteUserData:
+    properties:
+      associationProperties:
+        type: unknown
+        docs: |
+          
+          A list of users to delete, each specific using a specific criterion for deletion like `{ userId: "123" }`.
+    examples:
+      - name: ExampleDeleteUserData
+        value: 
+          associationProperties: [
+            {
+              userId: "123"
+            }
+          ]
+  DeleteUserDataResponse:
+    properties:
+      requestId:
+        type: string
+        docs: |
+
+          The request ID for this deletion request. You can use it to query the status of the deletion.
+    examples:
+      - name: ExampleDeleteUserDataResponse
+        value:
+          requestId: "456"
+
+  GetDeletionStatusResponse:
+    properties:
+      completed:
+        type: boolean
+        docs: |
+
+          `true` if the process was completed, `false` otherwise.
+      deleted:
+        type: string
+        docs: |
+
+          The number of spans that were deleted.
+      total: 
+        type: string
+        docs: |
+
+          The number of spans that need to be deleted in total.
diff --git a/fern/definition/tracing.yml b/fern/definition/tracing.yml
@@ -0,0 +1,88 @@
+docs: |
+
+service:
+  base-path: '/api/config/pii'
+  auth: true
+  endpoints:
+    enable:
+      display-name: Enable logging of prompts and responses
+      docs: |
+        By default, all prompts and responses are logged.
+
+        If you want to disable this behavior by following [this guide](/docs/openllmetry/privacy/prompts-completions-and-embeddings), you can selectively enable it for some of your users with this API.
+      path: "/tracing-allow-list"
+      method: POST
+      request: EnableLogging
+      examples:
+        - request: $EnableLogging.ExampleEnableLogging
+    get:
+      display-name: Get identifiers of users that are allowed to be logged
+      docs: |
+        By default, all prompts and responses are logged. 
+
+        If you’ve disabled this behavior by following [this guide](/docs/openllmetry/privacy/prompts-completions-and-embeddings), and then selectively enabled it for some of your users, then you can use this API to view which users you’ve enabled.
+      path: "/tracing-allow-list"
+      method: GET
+      response: GetIdentifiersResponse
+      examples:
+        - response: 
+            body: $GetIdentifiersResponse.ExampleGetIdentifiersResponse
+    disable:
+      display-name: Disable logging of prompts and responses for specific users
+      docs: |
+        By default, all prompts and responses are logged. 
+
+        If you’ve disabled this behavior by following [this guide](/docs/openllmetry/privacy/prompts-completions-and-embeddings), and then selectively enabled it for some of your users, then you can use this API to disable it for previously enabled ones.
+      path: "/tracing-allow-list"
+      method: DELETE
+      request: DisableLogging
+      examples:
+        - request: $DisableLogging.ExampleDisableLogging
+
+types:
+
+  EnableLogging:
+    properties:
+      associationPropertyAllowList:
+        type: unknown
+        docs: |
+          
+          The list of association properties (like `{ userId: "123" }`) that will be allowed to be logged.
+    examples:
+      - name: ExampleEnableLogging
+        value:
+          associationPropertyAllowList: [
+            userId: "123"
+          ]
+
+  GetIdentifiersResponse:
+    properties:
+      associationPropertyAllowList:
+        type: unknown
+        docs: |
+          
+          The list of association properties (like `{ userId: "123" }`) that are allowed to be logged.
+    examples:
+      - name: ExampleGetIdentifiersResponse
+        value: 
+          associationPropertyAllowList: [
+            {
+              userId: "123"
+            },
+            {
+              userId: "456",
+              chatId: "abc"
+            }
+          ]
+  DisableLogging:
+    properties:
+      associationProperty:
+        type: unknown
+        docs: |
+          
+          A single association property (like `{ userId: "123" }`) that was previously allowed to be logged.
+    examples:
+      - name: ExampleDisableLogging
+        value: 
+          associationProperty:
+            userId: "123"
diff --git a/fern/docs.yml b/fern/docs.yml
@@ -0,0 +1,155 @@
+instances:
+  - url: traceloop.docs.buildwithfern.com/docs
+    custom-domain: fern.traceloop.com/docs
+
+title: Traceloop | Docs
+
+tabs:
+  docs:
+    display-name: Documentation
+    icon: "fa-duotone fa-book-open"
+  llmetry: 
+    display-name: OpenLLMetry
+    icon: "fa-duotone fa-telescope"
+    slug: openllmetry
+  api:
+    display-name: Dashboard API
+    icon: "fa-duotone fa-webhook"
+
+navigation:
+  - tab: docs
+    layout: 
+      - section: Learn
+        contents:
+          - page: Introduction
+            path: ./pages/documentation/learn/intro.mdx
+      - section: Prompt Management
+        contents:
+          - page: Quick Start
+            path: ./pages/documentation/prompt-management/quickstart.mdx
+          - page: Prompt Registry
+            path: ./pages/documentation/prompt-management/prompt-registry.mdx
+          - page: Fetching Prompts
+            path: ./pages/documentation/prompt-management/fetching-prompts.mdx
+  - tab: llmetry
+    layout:
+      - section: Introduction
+        contents:
+          - page: What is OpenLLMetry?
+            path: ./pages/openllmetry/intro/what-is-llmetry.mdx
+      - section: Quick Start
+        contents: 
+          - page: Python
+            path: ./pages/openllmetry/quickstart/python.mdx
+          - page: Node.js
+            path: ./pages/openllmetry/quickstart/node.mdx
+          - page: Next.js
+            path: ./pages/openllmetry/quickstart/next.mdx
+          - page: Go
+            path: ./pages/openllmetry/quickstart/go.mdx
+          - page: Ruby
+            path: ./pages/openllmetry/quickstart/ruby.mdx
+          - page: SDK Initialization Options
+            path: ./pages/openllmetry/quickstart/sdk-initialization.mdx
+          - page: Troubleshooting
+            path: ./pages/openllmetry/quickstart/troubleshooting.mdx
+      - section: Tracing
+        contents: 
+          - page: Workflows, Tasks, Agents, and Tools
+            path: ./pages/openllmetry/tracing/workflows-tasks-agents-tools.mdx
+          - page: Associating Entities with Traces
+            path: ./pages/openllmetry/tracing/entities-traces.mdx
+          - page: Tracking User Feedback
+            path: ./pages/openllmetry/tracing/tracking-feedback.mdx
+          - page: Manual Implementations (Typescript / Javascript)
+            path: ./pages/openllmetry/tracing/manual-implementations.mdx
+          - page: Usage with Threads (Python)
+            path: ./pages/openllmetry/tracing/usage-threads.mdx
+          - page: Without OpenLLMetry SDK
+            path: ./pages/openllmetry/tracing/without-sdk.mdx
+      - section: Integrations
+        contents: 
+          - page: Overview
+            path: ./pages/openllmetry/integrations/overview.mdx
+          - page: Traceloop
+            path: ./pages/openllmetry/integrations/traceloop.mdx
+          - page: Axiom
+            path: ./pages/openllmetry/integrations/axiom.mdx
+          - page: Azure Applications Insights
+            path: ./pages/openllmetry/integrations/azure-insights.mdx
+          - page: Datadog
+            path: ./pages/openllmetry/integrations/datadog.mdx
+          - page: Dynatrace
+            path: ./pages/openllmetry/integrations/dynatrace.mdx
+          - page: Grafana
+            path: ./pages/openllmetry/integrations/grafana.mdx
+          - page: Honeycomb
+            path: ./pages/openllmetry/integrations/honeycomb.mdx
+          - page: HyperDX
+            path: ./pages/openllmetry/integrations/hyperdx.mdx
+          - page: Instana
+            path: ./pages/openllmetry/integrations/instana.mdx
+          - page: New Relic
+            path: ./pages/openllmetry/integrations/new-relic.mdx
+          - page: OpenTelemetry Collector
+            path: ./pages/openllmetry/integrations/opentelemetry-collector.mdx
+          - page: Service Now Cloud Observability
+            path: ./pages/openllmetry/integrations/service-now.mdx
+          - page: SigNoz
+            path: ./pages/openllmetry/integrations/signoz.mdx
+          - page: Sentry
+            path: ./pages/openllmetry/integrations/sentry.mdx
+          - page: Splunk
+            path: ./pages/openllmetry/integrations/splunk.mdx
+      - section: Privacy
+        contents: 
+          - page: Prompts, Completions, and Embeddings
+            path: ./pages/openllmetry/privacy/prompts-completions-embeddings.mdx
+          - page: Telemetry
+            path: ./pages/openllmetry/privacy/telemetry.mdx
+      - section: Contribute
+        contents: 
+          - page: Overview
+            path: ./pages/openllmetry/contribute/overview.mdx
+          - page: Local Development
+            path: ./pages/openllmetry/contribute/local-development.mdx
+          - page: GenAI Semantic Conventions
+            path: ./pages/openllmetry/contribute/gen-ai.mdx
+  - tab: api
+    layout:
+      - section: API Reference
+        contents:
+          - page: Introduction
+            path: ./pages/api/intro.mdx
+      - api: Endpoints
+
+navbar-links: 
+  - type: secondary
+    text: Community
+    url: https://traceloop.com/slack?_gl=1*898qql*_ga*NDc2NTEyODExLjE3MTAzMzg5OTc.*_ga_HPMNWFTJ5B*MTcxMDMzODk5Ni4xLjEuMTcxMDM1NjMyMy4wLjAuMA..
+  - type: secondary
+    text: Github
+    url: https://github.com/traceloop
+  - type: secondary
+    text: Website
+    url: https://www.traceloop.com/
+  - type: primary
+    text: Start Now
+    url: https://app.traceloop.com/
+
+layout:
+  searchbar-placement: header
+
+colors:
+  accentPrimary:
+    dark: "#ffb53d"
+    light: "#228BE6"
+  background:
+      light: "#ffffff"
+
+logo:
+  dark: ./assets/traceloop-dark.png
+  light: ./assets/traceloop-light.png
+  height: 24
+
+favicon: ./assets/favicon.png
diff --git a/fern/pages/documentation/learn/intro.mdx b/fern/pages/documentation/learn/intro.mdx
@@ -0,0 +1,53 @@
+---
+excerpt: Monitor, debug and test the quality of your LLM outputs
+---
+
+Traceloop automatically monitors the quality of your LLM outputs. It helps you to debug and test changes to your models and prompts.
+
+- Get real-time alerts about your model’s quality
+- Execution tracing for every request
+- Gradually rollout changes to models and prompts
+- Debug and re-run issues from production in your IDE
+
+Need help using Traceloop? Ping us at [[email protected]](mailto:[email protected])
+
+## Get Started - Install OpenLLMetry SDK
+
+Traceloop natively plugs into OpenLLMetry SDK. To get started, pick the language you are using and follow the instructions.
+
+<Cards>
+  <Card
+    title="Python"
+    icon="fa-brands fa-python"
+    href="/docs/openllmetry/quick-start/python"
+  >
+    Available
+  </Card>
+  <Card
+    title="Javascript / Typescript"
+    icon="fa-brands fa-node"
+    href="/docs/openllmetry/quick-start/node-js"
+  >
+    Available
+  </Card>
+  <Card
+    title="Go"
+    icon="fa-brands fa-golang"
+    href="/docs/openllmetry/quick-start/go"
+  >
+    Beta
+  </Card>
+  <Card
+    title="Ruby"
+    icon="fa-regular fa-gem"
+    href="/docs/openllmetry/quick-start/ruby"
+  >
+    Beta
+  </Card>
+  <Card title="Java" icon="fa-brands fa-java">
+    In Development
+  </Card>
+  <Card title="Elixir" icon="fa-regular fa-droplet">
+    In Development
+  </Card>
+</Cards>