API Overview
Modules
Classes
client.AgentsClient
: Client to interact withagents
endpoint.client.ApiClient
: Implementation of the API client to interact with core-servicesclient.EndpointsClient
: Client to interact withendpoints
endpoint.client.EndpointsClient
: Client to interact withendpoints
endpoint.client.JobsClient
: Client to interact withjobs
endpoint.client.ModelsClient
: Client to interact withmodels
endpoint.client.ProofsClient
: Client to interact withproofs
endpoint.client.TranspileClient
: Client to interact withusers
endpoint.client.UsersClient
: Client to interact withusers
endpoint.client.VersionJobsClient
: Client to interact withjobs
endpoint.client.VersionsClient
: Client to interact withversions
endpoint.client.WorkspaceClient
: Client to interact withworkspaces
endpoint.echo.Echo
: Helper class to use when printin output of the CLI.exception_handling.ExceptionHandler
: Context manager to handle exceptions in the CLI.
Functions
callbacks.debug_callback
: If a call adds the--debug
flag debugging mode is activated for external requests and API Clients.callbacks.version_callback
: Prints the current version when--version
flag is added to a call.actions.new
: This command will create a new action by generating a Python project.models.create
: Command to create a model. Asks for the new model's information and validates the input,models.get
: Command to create a user. Asks for the new users information and validates the input,models.list
: Command to list all models.reset_password.handle_http_error
: Handle an HTTP error.reset_password.prompt_for_input
: Prompt the user for input.reset_password.request_reset_password_token
: Request a password reset token for a given email.reset_password.reset_password
: Reset the password for a user using a reset token.users.create
: Command to create a user. Asks for the new users information and validates the input,users.create_api_key
: Create an API key for your user. You need to be logged in to create an API key.users.login
: Logs the current user into Giza. Under the hood this will retrieve the token for the next requests.users.me
: Retrieve information about the current user and print it as json to stdout.users.resend_email
: Command to resend verification email. Asks for the user's email and sends the request to the APIversion.check_version
: Check if there is a new version available of the cli in pypi to suggest upgradeversions.download
: Retrieve information about the current user and print it as json to stdout.versions.download_original
: Retrieve information about the current user and print it as json to stdout.workspaces.create
: Command to create a Giza Workspace.cairo.deploy
: Command to deploy a specific version of a model. This will create an endpoint for the specified version and check the status, once it finishes if COMPLETED the endpoint is ready to be used.cairo.prove
: Command to prove as spceific cairo program, previously converted to CASM.cairo.transpile
: This function is responsible for transpiling a model. The overall objective is to prepare a model for use by converting it into a different format (transpiling).cairo.verify
: Create a verification job.ezkl.deploy
: Command to deploy a specific version of a model. This will create a endpoint for the specified version and check the status, once it finishes if COMPLETED the endpoint is ready to be used.ezkl.setup
: This function executes the setup of the model and creates the outputs, handled by Giza.ezkl.verify
: Create a verification job.utils.get_response_info
: Utility to retrieve information of the client response.decorators.auth
: Check that we have the token and it is not expired before executingmisc.download_model_or_sierra
: Download the model or sierra file.misc.get_ape_accounts
: Get the available APE accounts.misc.get_parameters_from_str
: Get the parameters from a string.misc.load_json_file
: Load a json file.misc.scarb_build
: Build the scarb model.misc.zip_folder
: Zip the folder to a specific location.
Last updated