Skip to content

Document Pipecat text memory installation and run requirements - #1013

Open
zlareb1 wants to merge 3 commits into
mainfrom
docs/pipecat-integration-readme
Open

zlareb1 wants to merge 3 commits into
mainfrom
docs/pipecat-integration-readme

Conversation

@zlareb1

@zlareb1 zlareb1 commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

Related: #947

Changelog category (leave one):

  • Documentation (changelog entry is not required)

Changelog entry

Not required.

Why

The SDK README names the Pipecat adapter but does not give its pipeline example, run prerequisites or tested scope. Add a dedicated integration README and changelog beside the single-file example, linked from the SDK and examples indexes.

Scope and risk

The README gives the exact source install used by the native check, processor placement, an application environment recipe and the existing single-file entry point. It identifies ClickHouse maintenance, the Apache license, data location, scoped token requirements and the application's existing session-family authority.

Validation claims remain limited to Pipecat 1.16.0 with a real asynchronous Agent, authentication and fake server providers. The hosted check calls Python main() with a fresh pointer; it does not launch the CLI separately or qualify existing/protected-family restore, audio, interruption handling or a completed video. The changelog uses an Unreleased section without assigning the example to a published SDK version.

This changes documentation only. It adds no wrapper package, provider, API, family-creation path or release requirement.

Compatibility, rollout and rollback

  • Wire schema, settings and runtime behavior: none.
  • No package version changes. Existing native example and adapter bytes are unchanged.
  • Reverting removes the documentation and index links.

Tests

Small checks of the four changed Markdown files passed public-copy rules, relative links, sample Python AST and shell syntax, and correspondence with the existing example's environment keys. The first hosted lint failure was corrected to Ruff's expected single-line expressions. A hosted package-README test then rejected the added relative link: package registry pages require an absolute link. It follows the neighboring canonical GitHub main-branch links. The exact registry-link regression passes (one test). The four-file documentation validator and scoped Ruff and Prettier checks pass. Full required hosted CI and a fresh independent pushed-head review remain required before merge.

No example, product service, browser, database or provider is run for this documentation change.

AI assistance in the code (leave one; writing this description with AI is fine):

  • AI-generated: Codex wrote the documentation. Source inspection covers the existing example, adapter contract, actual native receipts, repository prerequisites and the documented qualification limits. Validation is listed above.

  • I can explain every line of this diff and how it interacts with the rest of Loom.

Checklist

  • Required hosted CI passes.
  • No wire schema, migration, generated SDK, plugin or frontend change.
  • No sandbox, ownership, timeout or native assertion changes.
  • The pushed head and entire final body receive an independent review.
  • Commits are signed off.

Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>
Signed-off-by: zlareb1 <lareb.zafar@clickhouse.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant