For the complete documentation index, see llms.txt.

Experimental features in the CSQ Flutter SDK

Dernière mise à jour Voir en Markdown

Experimental features in the CSQ Flutter SDK are available before their official release, so you can try them early and send feedback. They carry the @experimental annotation, and their API, behavior, or scope can change or be removed without a major version bump.

What the experimental annotation means

Section titled What the experimental annotation means

The @experimental annotation marks features that you can use but that aren't yet fully stable. It lets us share new capabilities earlier, and it warns you that the feature is still under evaluation.

Why features are marked experimental

Section titled Why features are marked experimental
  • API stability: Although tested internally, the API might still evolve based on customer feedback.
  • Customer needs: We want to confirm that a feature fully addresses your needs before it becomes a permanent part of the SDK.
  • Transparency: We want to be clear about the status of a feature and its potential for change.

When you adopt an experimental feature, keep these points in mind:

  • Logs: The SDK prints a log message indicating that the feature is experimental.
  • Risk of breaking changes: The feature can change significantly, or be removed, without prior notice and without a major version bump.
  • Documentation and support: We provide up-to-date documentation, including usage examples.
  • Changelog updates: Any introduction of or change to an experimental feature is documented in the changelog.

Experimental feature lifecycle

Section titled Experimental feature lifecycle

An experimental feature follows one of three paths.

If the feature proves successful and meets customer needs, it graduates from experimental status. We remove the annotation and integrate the feature into the SDK as a stable component. The documentation and changelog are updated to reflect this change.

If the feature is unnecessary or ineffective, it moves toward deprecation. We mark it as @deprecated in an upcoming release to signal that it will no longer be supported, then remove it in a later release. The documentation is updated to communicate the deprecation and removal.

If the feature needs further development, it remains experimental while we adjust its API, behavior, and scope.

Provide feedback on experimental features

Section titled Provide feedback on experimental features

Your feedback shapes the final version of experimental features. Share any issues you encounter, suggestions for improvement, or use cases the feature supports well.

The most direct way to give feedback is to submit a support ticket. Mention that you're using an experimental feature and include any relevant details.