Skip to content

docs: clarify cookbook Chat API uses PyPI cloud SDK#359

Open
MS170998 wants to merge 1 commit into
VectifyAI:mainfrom
MS170998:fix/clarify-chat-api-cookbooks-345
Open

docs: clarify cookbook Chat API uses PyPI cloud SDK#359
MS170998 wants to merge 1 commit into
VectifyAI:mainfrom
MS170998:fix/clarify-chat-api-cookbooks-345

Conversation

@MS170998

Copy link
Copy Markdown

Summary

  • Clarify that chat_completions / submit_document come from the PageIndex Cloud SDK on PyPI, not this repo's local PageIndexClient
  • Fail fast in cookbooks if the local package shadows the SDK
  • Point to cloud docs and the self-hosted agentic demo

Closes #345

Test plan

  • Open both cookbooks and confirm the install note is visible
  • Importing the local client without cloud SDK raises the new ImportError
  • With pip install pageindex cloud SDK, setup cell passes the hasattr check

Cookbooks call chat_completions on PageIndexClient, which exists only in the
cloud SDK from PyPI—not in this repo's local client. Document the distinction
and fail fast if the local package shadows the SDK.

Closes VectifyAI#345

Co-authored-by: Cursor <cursoragent@cursor.com>
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.

Non-existent PageIndexClient.chat_completion method mentioned in cookbooks.

1 participant