Skip to main content

RemoteHttpRuntime

A runtime that runs functions in a remote HTTP server. You need to run the API server in the remote server first. Parameters:
  • host (str): The host of the remote server.
  • port (int): The port of the remote server. (default: :obj:8000) (default: 8000)
  • python_exec (str): The python executable to run the API server. (default: :obj:python3)

init

build

Returns: RemoteHttpRuntime: The current runtime.

cleanup

Stop and release the API server process.

add

Add a function or list of functions to the runtime. Parameters:
  • funcs (Union[FunctionTool, List[FunctionTool]]): The function or list of functions to add.
  • entrypoint (str): The entrypoint for the function.
  • redirect_stdout (bool): Whether to return the stdout of the function. (default: :obj:False)
  • arguments (Optional[Dict[str, Any]]): The arguments for the function. (default: :obj:None)
Returns: RemoteHttpRuntime: The current runtime.

ok

Returns: bool: Whether the API Server is running.

wait

Wait for the API Server to be ready. Parameters:
  • timeout (int): The number of seconds to wait. (default: :obj:10) (default: 10)
Returns: bool: Whether the API Server is ready.

del

Clean up the API server when the object is deleted.

stop

Returns: RemoteHttpRuntime: The current runtime.

reset

Returns: RemoteHttpRuntime: The current runtime.

docs

Returns: str: The URL for the API documentation.