Skip to main content

Sema4AI Actions

Project description

⚡️ sema4ai-actions

A Python library designed to simplify the development of Python actions (AI or otherwise) to be run with the Sema4.ai Action Server.

Getting started

If you have not setup Action Server already, see the 🏃‍♂️ Quickstart on how to do that.

Decorate your Python function with the @action decorator:

from sema4ai.actions import action

@action
def sum_numbers(a: float, b: float) -> float:
    ...

And your function is now an ⚡️Action!

You can now run and debug your action by Starting Action Server with action-server start and accessing the UI at http://localhost:8080.

Note: Action inputs and outputs support only int, float, str and bool types.

Describe your action

For an action's purpose and usage to be understood by AI models (and humans) it needs to be documented correctly.

To do that, use Google Style Docstring to write a clear and concise description on what your action does and document the action inputs and expected output:

@action
def get_weather_forecast(city: str, days: int, scale: str = "celsius") -> str:
    """
    Returns weather conditions forecast for a given city.

    Args:
        city (str): Target city to get the weather conditions for
        days: How many day forecast to return
        scale (str): Temperature scale to use, should be one of "celsius" or "fahrenheit"

    Returns:
        str: The requested weather conditions forecast
    """
    ...

Tip: Experiment with and iterate the exact documentation wording to get more predictable results when using your action with AI apps.


Consequential flag

You can explicitly provide the is_consequential flag for an action to mark it's operations as "must always prompt the user for confirmation before running" by OpenAI GPTs (and possibly by other providers). If set to False, the user will be provided with an "always allow" feature.

@action(is_consequential=True)
def get_weather_forecast(city: str, days: int, scale: str = "celsius") -> str:

Execution

To get the full benefits of your actions, the suggested way to run them is using Action Server. But it's also possible to do that directly in command line by passing the named arguments:

python -m sema4ai.actions run -- --city=Helsinki --days=3

Guides

API Reference

Explore our API for extensive documentation.

Changelog

A list of releases and corresponding changes can be found in the changelog.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sema4ai_actions-0.9.0.tar.gz (50.2 kB view details)

Uploaded Source

Built Distribution

sema4ai_actions-0.9.0-py3-none-any.whl (62.3 kB view details)

Uploaded Python 3

File details

Details for the file sema4ai_actions-0.9.0.tar.gz.

File metadata

  • Download URL: sema4ai_actions-0.9.0.tar.gz
  • Upload date:
  • Size: 50.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1021-azure

File hashes

Hashes for sema4ai_actions-0.9.0.tar.gz
Algorithm Hash digest
SHA256 ee6aae897dd00a723d08a17d5a6c7ccaf4efa12ac29096ca965a0a4918535f45
MD5 c2ad8fc61f55aec11e437dc0c8a92db1
BLAKE2b-256 5765c2fa6f3c9b75c22600c310b38da24e6e17251658ae2695a4a75d3bc3fb07

See more details on using hashes here.

Provenance

File details

Details for the file sema4ai_actions-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: sema4ai_actions-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 62.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1021-azure

File hashes

Hashes for sema4ai_actions-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b564acef59433e7bcfb72b08b728d39177073ec0e00b7b694e8f7ab75910b90b
MD5 830c3db8480cc6e029e1e9ee65d9885a
BLAKE2b-256 c1a1f9af6b64cbdad92139864cab443402d245d692c8c75dcb235a3aef878538

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page