Skip to content

Releases: cogsol/cogsol-framework

v0.2.1

11 Mar 17:42

Choose a tag to compare

What's new

This release improves authentication and configuration handling, strengthens migration reliability, and updates documentation for setup and usage.

Added

  • Optional Azure AD B2C client-credentials authentication in CogSolClient with automatic bearer token acquisition.

Changed

  • Standardized API key configuration on COGSOL_API_KEY.
  • CogSolClient now sends bearer tokens when configured and retries once after refreshing credentials on 401.
  • Centralized API base URL resolution via shared helpers with support for COGSOL_ENV, COGSOL_API_BASE, and COGSOL_CONTENT_API_BASE.
  • Fallback to legacy cognitive/content API base URLs when auth credentials are not configured.
  • startagent now validates generated slugs and class names more strictly, and generated templates no longer append a redundant Chat suffix to chat_name.
  • Tool parameter sync now preserves items metadata for array parameters.
  • startproject template .env.example now includes API key and optional auth credential placeholders.
  • Runtime dependencies now include msal and PyJWT.

Fixed

  • Migration ordering for agent dependencies to avoid first-run failures.
  • startproject now includes an active ExampleTool implementation by default.
  • Migration tool payload sync now preserves configurable tool flags instead of hardcoding them.
  • Migration finalization now rolls back partially created API objects when sync fails.
  • Tool migration sync now preserves helper methods, double quotes, and multiline helper/run signatures more reliably.
  • Improved chat banner alignment and terminal output rendering.

Documentation

  • Updated environment variable and authentication docs to use COGSOL_API_KEY.
  • Removed outdated “no external dependencies” statements.
  • Clarified that documentation in README examples is only a sample topic name.
  • Updated retrieval-tool examples to instantiate retrieval definitions.
  • Added explicit .venv setup instructions.
  • Clarified clone-directory setup steps.

Upgrade notes

  • Update the package to 0.2.1.
  • Review your environment variables and use COGSOL_API_KEY instead of COGSOL_API_TOKEN.
  • If you use custom auth setup, verify your COGSOL_AUTH_CLIENT_ID and COGSOL_AUTH_SECRET configuration.