futurehouse-client 0.0.4__py3-none-any.whl → 0.0.5__py3-none-any.whl

{futurehouse_client-0.0.4.dist-info → futurehouse_client-0.0.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: futurehouse-client
-Version: 0.0.4
+Version: 0.0.5
 Summary: A client for interacting with endpoints of the FutureHouse service.
 Author-email: FutureHouse technical staff <hello@futurehouse.org>
 Classifier: Operating System :: OS Independent
@@ -38,101 +38,76 @@ Requires-Dist: setuptools_scm; extra == "dev"
 
 # FutureHouse Platform API Documentation
 
-Documentation and tutorials for crow-client, a client for interacting with endpoints of the FutureHouse crow service.
-
-> FutureHouse's mascot is the crow. Therefore, some objects are named after the crow as a homage.
+Documentation and tutorials for futurehouse-client, a client for interacting with endpoints of the FutureHouse platform.
 
 <!--TOC-->
 
 - [Installation](#installation)
 - [Quickstart](#quickstart)
 - [Functionalities](#functionalities)
-  - [Stages](#stages)
 - [Authentication](#authentication)
-- [Job submission](#job-submission)
-- [Job Continuation](#job-continuation)
-- [Job retrieval](#job-retrieval)
+- [Task submission](#task-submission)
+- [Task Continuation](#task-continuation)
+- [Task retrieval](#task-retrieval)
 
 <!--TOC-->
 
 ## Installation
 
 ```bash
-uv pip install crow-client
+uv pip install futurehouse-client
 ```
 
 ## Quickstart
 
 ```python
-from crow_client import CrowClient, JobNames
+from futurehouse_client import FutureHouseClient, JobNames
 from pathlib import Path
 from aviary.core import DummyEnv
 import ldp
 
-client = CrowClient(
-    stage=Stage.PROD,
-    auth_type=AuthType.API_KEY,
+client = FutureHouseClient(
     api_key="your_api_key",
 )
 
-job_data = {
+task_data = {
     "name": JobNames.CROW,
-    "query": "Has anyone tested therapeutic exerkines in humans or NHPs?",
+    "query": "Which neglected diseases had a treatment developed by artificial intelligence?",
 }
 
-job_run_id = client.create_job(job_data)
+task_run_id = client.create_task(task_data)
 
-job_status = client.get_job(job_run_id)
+task_status = client.get_task(task_run_id)
 ```
 
-A quickstart example can be found in the [crow_client_notebook.ipynb](./docs/crow_client_notebook.ipynb) file, where we show how to submit and retrieve a job task, pass runtime configuration to the agent, and ask follow-up questions to the previous job.
+A quickstart example can be found in the [client_notebook.ipynb](https://github.com/Future-House/futurehouse-client-docs/blob/main/docs/client_notebook.ipynb) file, where we show how to submit and retrieve a job task, pass runtime configuration to the agent, and ask follow-up questions to the previous job.
 
 ## Functionalities
 
-Crow-client implements a RestClient (called `CrowClient`) with the following functionalities:
+FutureHouse client implements a RestClient (called `FutureHouseClient`) with the following functionalities:
 
-- [Authentication](#authtype): `auth_client`
-- [Job submission](#job-submission): `create_job(JobRequest)`
-- [Job status](#job-status): `get_job(job_id)`
-
-To create a `CrowClient`, you need to pass the following parameters:
-| Parameter | Type | Default | Description |
-| --- | --- | --- | --- |
-| stage | Stage | Stage.DEV | Where the job will be submitted? |
-| organization | str \| None | None | Which organization to use? |
-| auth_type | AuthType | AuthType.API_KEY | Which authentication method to use? |
-| api_key | str \| None | None | The API key to use for authentication, if using auth_type=AuthType.API_KEY. |
+- [Task submission](#task-submission): `create_task(TaskRequest)`
+- [Task status](#task-status): `get_task(task_id)`
 
-To instantiate a Client, we can use the following code:
+To create a `FutureHouseClient`, you need to pass an FutureHouse platform api key (see [Authentication](#authentication)):
 
 ```python
-from crow_client import CrowClient
-from crow_client.models import Stage, AuthType
+from futurehouse_client import FutureHouseClient
 
-client = CrowClient(
-    stage=Stage.PROD,
-    organization="your_organization",
-    auth_type=AuthType.API_KEY,
+client = FutureHouseClient(
     api_key="your_api_key",
 )
 ```
 
-### Stages
-
-The stage is where your job will be submitted. This parameter can be one of the following:
-| Name | Description |
-| --- | --- |
-| Stage.DEV | Development environment at https://dev.api.platform.futurehouse.org |
-| Stage.PROD | Production environment at https://api.platform.futurehouse.org |
-
 ## Authentication
 
-In order to use the `CrowClient`, you need to authenticate yourself. Authentication is done by providing an API key, which can be obtained directly from your [profile page in the FutureHouse platform](https://platform.futurehouse.org/profile).
+In order to use the `FutureHouseClient`, you need to authenticate yourself. Authentication is done by providing an API key, which can be obtained directly from your [profile page in the FutureHouse platform](https://platform.futurehouse.org/profile).
 
-## Job submission
+## Task submission
 
-`CrowClient` can be used to submit jobs to the FutureHouse platform. Using a `CrowClient` instance, you can submit jobs to the platform by calling the `create_job` method, which receives a `JobRequest` (or a dictionary with `kwargs`) and returns the job id.
-Aiming to make the submission of jobs as simple as possible, we have created a `JobNames` enum that contains the available job types.
+In the futurehouse platform, we define the deployed combination of an agent and an environment as a `job`. To invoke a job, we need to submit a `task` (also called a `query`) to it.
+`FutureHouseClient` can be used to submit tasks/queries to available jobs in the FutureHouse platform. Using a `FutureHouseClient` instance, you can submit tasks to the platform by calling the `create_task` method, which receives a `TaskRequest` (or a dictionary with `kwargs`) and returns the task id.
+Aiming to make the submission of tasks as simple as possible, we have created a `JobNames` `enum` that contains the available task types.
 
 The available supported jobs are:
 | Alias | Job Name | Task type | Description |
@@ -143,27 +118,24 @@ The available supported jobs are:
 | `JobNames.DUMMY` | `job-futurehouse-dummy` | Dummy Task | This is a dummy task. Mainly for testing purposes. |
 
 Using `JobNames`, the client automatically adapts the job name to the current stage.
-The job submission looks like this:
+The task submission looks like this:
 
 ```python
-from crow_client import CrowClient, JobNames
-from crow_client.models import AuthType, Stage
+from futurehouse_client import FutureHouseClient, JobNames
 
-client = CrowClient(
-    stage=Stage.PROD,
-    auth_type=AuthType.API_KEY,
+client = FutureHouseClient(
     api_key="your_api_key",
 )
 
-job_data = {
-    "name": JobNames.CROW,
+task_data = {
+    "name": JobNames.OWL,
     "query": "Has anyone tested therapeutic exerkines in humans or NHPs?",
 }
 
-job_id = client.create_job(job_data)
+task_id = client.create_task(task_data)
 ```
 
-`JobRequest` has the following fields:
+`TaskRequest` has the following fields:
 
 | Field          | Type          | Description                                                                                                         |
 | -------------- | ------------- | ------------------------------------------------------------------------------------------------------------------- |
@@ -175,51 +147,46 @@ job_id = client.create_job(job_data)
 `runtime_config` can receive a `AgentConfig` object with the desired kwargs. Check the available `AgentConfig` fields in the [LDP documentation](https://github.com/Future-House/ldp/blob/main/src/ldp/agent/agent.py#L87). Besides the `AgentConfig` object, we can also pass `timeout` and `max_steps` to limit the execution time and the number of steps the agent can take.
 Other especialised configurations are also available but are outside the scope of this documentation.
 
-## Job Continuation
+## Task Continuation
 
-Once a job is submitted and the answer is returned, FutureHouse platform allow you to ask follow-up questions to the previous job.
+Once a task is submitted and the answer is returned, FutureHouse platform allow you to ask follow-up questions to the previous task.
 It is also possible through the platform API.
-To accomplish that, we can use the `runtime_config` we discussed in the [Job submission](#job-submission) section.
+To accomplish that, we can use the `runtime_config` we discussed in the [Task submission](#task-submission) section.
 
 ```python
-from crow_client import CrowClient, JobNames
-from crow_client.models import AuthType, Stage
+from futurehouse_client import FutureHouseClient, JobNames
 
-client = CrowClient(
-    stage=Stage.PROD,
-    auth_type=AuthType.API_KEY,
+client = FutureHouseClient(
     api_key="your_api_key",
 )
 
-job_data = {"name": JobNames.CROW, "query": "How many species of birds are there?"}
+task_data = {"name": JobNames.CROW, "query": "How many species of birds are there?"}
 
-job_id = client.create_job(job_data)
+task_id = client.create_task(task_data)
 
-continued_job_data = {
+continued_task_data = {
     "name": JobNames.CROW,
     "query": "From the previous answer, specifically,how many species of crows are there?",
-    "runtime_config": {"continued_job_id": job_id},
+    "runtime_config": {"continued_task_id": task_id},
 }
 
-continued_job_id = client.create_job(continued_job_data)
+continued_task_id = client.create_task(continued_task_data)
 ```
 
-## Job retrieval
+## Task retrieval
 
-Once a job is submitted, you can retrieve it by calling the `get_job` method, which receives a job id and returns a `JobResponse` object.
+Once a task is submitted, you can retrieve it by calling the `get_task` method, which receives a task id and returns a `TaskResponse` object.
 
 ```python
-from crow_client import CrowClient
-from crow_client.models import AuthType
+from futurehouse_client import FutureHouseClient
 
-client = CrowClient(
-    auth_type=AuthType.API_KEY,
+client = FutureHouseClient(
     api_key="your_api_key",
 )
 
-job_id = "job_id"
+task_id = "task_id"
 
-job_status = client.get_job(job_id)
+task_status = client.get_task(task_id)
 ```
 
-`job_status` contains information about the job. For instance, its `status`, `task`, `environment_name` and `agent_name`, and other fields specific to the job.
+`task_status` contains information about the task. For instance, its `status`, `task`, `environment_name` and `agent_name`, and other fields specific to the job.

{futurehouse_client-0.0.4.dist-info → futurehouse_client-0.0.5.dist-info}/RECORD

@@ -8,7 +8,7 @@ futurehouse_client/models/client.py,sha256=n4HD0KStKLm6Ek9nL9ylP-bkK10yzAaD1uIDF
 futurehouse_client/models/rest.py,sha256=W-wNFTN7HALYFFphw-RQYRMm6_TSa1cl4T-mZ1msk90,393
 futurehouse_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 futurehouse_client/utils/module_utils.py,sha256=aFyd-X-pDARXz9GWpn8SSViUVYdSbuy9vSkrzcVIaGI,4955
-futurehouse_client-0.0.4.dist-info/METADATA,sha256=mb918ca4LdaKsctNjrzswLkfq-NAfD0s6CmjWqyvo3I,8898
-futurehouse_client-0.0.4.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-futurehouse_client-0.0.4.dist-info/top_level.txt,sha256=TRuLUCt_qBnggdFHCX4O_BoCu1j2X43lKfIZC-ElwWY,19
-futurehouse_client-0.0.4.dist-info/RECORD,,
+futurehouse_client-0.0.5.dist-info/METADATA,sha256=2OxntdouInoOXVuPlmVmKkIwZ7g4E_rilBDZ0HCkobU,8056
+futurehouse_client-0.0.5.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+futurehouse_client-0.0.5.dist-info/top_level.txt,sha256=TRuLUCt_qBnggdFHCX4O_BoCu1j2X43lKfIZC-ElwWY,19
+futurehouse_client-0.0.5.dist-info/RECORD,,