WorkflowAI
  • Welcome
  • Getting Started
    • For Product Managers
    • For Developers
    • Creating and Managing Organizations
  • AI Features Playbook
    • Introduction
    • What is an AI Feature?
    • Defining your AI Feature
    • Testing your AI Feature
    • Evaluating your AI Feature
    • Adding your AI Feature to your Product (and Beyond)
    • Improving your AI Feature
  • Use Cases
    • Image Generation (NEW!)
  • Concepts
    • Schemas
    • Versions
    • Runs
    • Tools
  • Features
    • Playground
    • Reviews
    • Side by Side
    • Benchmarks
    • Code
    • Deployments
    • User Feedback
    • Monitoring
    • Limitations
    • Change Log
  • WorkflowAI Cloud
    • Introduction
    • Pricing
    • Reliability
    • Compliance
  • Developers
    • For Developers
  • Python SDK
    • Get started
    • @workflowai.agent
    • Schemas
    • Versions
    • Deployments
    • Multimodality
    • Tools
    • Errors
    • Examples
    • Workflows
  • Integrations
    • Instructor
  • Support
    • Email
    • GitHub Discussions
    • Discord
Powered by GitBook

Support

  • Slack
  • Github

Company

  • workflowai.com
  • Join
On this page
  • Deploying a Version
  • Integrating Your WorkflowAI Feature into Your Codebase
  • Monitoring Runs
  • Integrating WorkflowAI Feedback into Your Codebase
  • Monitoring Feedback
  • Sharing your AI Feature
  • If your AI feature is public
  • If your AI feature is private

Was this helpful?

Edit on GitHub
  1. AI Features Playbook

Adding your AI Feature to your Product (and Beyond)

PreviousEvaluating your AI FeatureNextImproving your AI Feature

Last updated 1 month ago

Was this helpful?

After finding a suitable version of the feature, it can be integrated into your product by deploying it.

Deploying a Version

Once a suitable version is identified, the recommended next step is deploying the version to a WorkflowAI environment. WorkflowAI provides three environment options: dev, staging, production. A single version can be deployed to one or multiple environments.

Deploying a version enables your product’s codebase to reference the version with an environment variable (any of the three mentioned above) rather than a hardcoded version number. Using environment variables simplifies the process of updating versions; updating a deployed version on WorkflowAI automatically updates the version the environment variable references within your product. No engineering intervention required!

Note: deploying a version on a different schema will require a code update. Schema updates are considered breaking changes, thus necessitating hardcoded version numbers in the product's codebase.

Integrating Your WorkflowAI Feature into Your Codebase

For software engineers

After deploying your chosen version to an environment:

  1. Go to the Code page.

  2. Select your programming language.

  3. Install the WorkflowAI package

  4. Copy the provided integration code and paste into your codebase. Be sure to select the desired version with the desired environment icon from the version-selection dropdown to ensure the correct version is referenced in the generated code.

Monitoring Runs

Once deployed, it’s recommended to monitor real-time feature runs (via the page) through WorkflowAI to help identify and rectify early issues. All Runs of a feature are logged automatically on the Run’s page, so they can be accessed and viewed any time.

If issues with the feature are observed, refer to the section for common issues and tips on how to resolve them.

Integrating WorkflowAI Feedback into Your Codebase

For software engineers

Monitoring Feedback

User feedback is essential for continuous improvement. Monitoring responses through WorkflowAI’s feedback system helps determine where enhancements are needed. The WorkflowAI feedback integration also connects to Slack so you'll be able to have user feedback sent from the WorkflowAI web app to Slack to make it easier to discuss the feedback insights with your team.

Sharing your AI Feature

If your AI feature is public

If you want to share your public AI feature with others, you can do so by sharing the feature's URL with them.

If your AI feature is not public but you would like it to be:

  1. Select Settings on the side bar of your feature

  2. Select Change AI Agent Visibility and confirm

If your AI feature is private

If your AI feature is private, you can share the feature with others by inviting them to your organization.

To invite others:

  1. Go to the Code page of your feature

  2. Select Invite Team

  3. Enter the email of the person you want to invite

Once the user accepts the invitation, they will be added to your organization and will have access to the feature.

After integrating the feature into your product, consider integrating WorkflowAI's into your product to collect user insights directly. The feedback component allows you to easily collect user feedback on your WorkflowAI feature to inform ongoing feature improvement.

Login to

Login to

Runs
Improving your AI Feature
feedback component
WorkflowAI
WorkflowAI