Skip to content

base_griptape_cloud_tool

BaseGriptapeCloudTool

Bases: BaseTool, ABC

Base class for Griptape Cloud clients.

Attributes:

Name Type Description
base_url str

Base URL for the Griptape Cloud Knowledge Base API.
api_key Optional[str]

API key for Griptape Cloud.
headers dict

Headers for the Griptape Cloud Knowledge Base API.
Source code in griptape/tools/base_griptape_cloud_tool.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@define
class BaseGriptapeCloudTool(BaseTool, ABC):
    """Base class for Griptape Cloud clients.

    Attributes:
        base_url: Base URL for the Griptape Cloud Knowledge Base API.
        api_key: API key for Griptape Cloud.
        headers: Headers for the Griptape Cloud Knowledge Base API.
    """

    base_url: str = field(
        default=Factory(lambda: os.getenv("GT_CLOUD_BASE_URL", "https://cloud.griptape.ai")),
        kw_only=True,
    )
    api_key: Optional[str] = field(default=Factory(lambda: os.getenv("GT_CLOUD_API_KEY")), kw_only=True)
    headers: dict = field(
        default=Factory(lambda self: {"Authorization": f"Bearer {self.api_key}"}, takes_self=True),
        kw_only=True,
    )

api_key: Optional[str] = field(default=Factory(lambda: os.getenv('GT_CLOUD_API_KEY')), kw_only=True) class-attribute instance-attribute

base_url: str = field(default=Factory(lambda: os.getenv('GT_CLOUD_BASE_URL', 'https://cloud.griptape.ai')), kw_only=True) class-attribute instance-attribute

headers: dict = field(default=Factory(lambda self: {'Authorization': f'Bearer {self.api_key}'}, takes_self=True), kw_only=True) class-attribute instance-attribute