tako-sdk 0.1.4__tar.gz

tako_sdk-0.1.4/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: tako-sdk
+Version: 0.1.4
+Summary: A Python SDK for interacting with the Tako API
+Author: Tako
+Author-email: support@trytako.com
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic==2.8.2
+Requires-Dist: pytest==7.4.3
+Requires-Dist: requests==2.32.3
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Tako Python SDK 
+
+The Tako Python SDK is a Python library that makes it easy for applications to use the Tako Knowledge Search API
+
+## Requirements
+
+The Tako Python SDK supports Python 3.9+
+
+## Installation
+
+```bash
+pip install tako-sdk
+```
+
+## Testing
+```bash
+export TAKO_API_KEY=<your-tako-server-api-key>
+export TAKO_SERVER_URL=<tako-server-url>
+pytest tests/integration/ -v
+```
+
+## Contributions
+
+This repo is currently maintained by Tako developers. As we evolve this repo, contributors outside of
+Tako will be welcome and developer guides added.
+
+## Support
+
+For support, please [create an issue](https://github.com/[organization]/tako-sdk/issues) in our GitHub repository. 

tako_sdk-0.1.4/README.md

@@ -0,0 +1,29 @@
+# Tako Python SDK 
+
+The Tako Python SDK is a Python library that makes it easy for applications to use the Tako Knowledge Search API
+
+## Requirements
+
+The Tako Python SDK supports Python 3.9+
+
+## Installation
+
+```bash
+pip install tako-sdk
+```
+
+## Testing
+```bash
+export TAKO_API_KEY=<your-tako-server-api-key>
+export TAKO_SERVER_URL=<tako-server-url>
+pytest tests/integration/ -v
+```
+
+## Contributions
+
+This repo is currently maintained by Tako developers. As we evolve this repo, contributors outside of
+Tako will be welcome and developer guides added.
+
+## Support
+
+For support, please [create an issue](https://github.com/[organization]/tako-sdk/issues) in our GitHub repository. 

tako_sdk-0.1.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tako_sdk-0.1.4/setup.py

@@ -0,0 +1,24 @@
+from setuptools import setup, find_packages
+
+# Read README.md
+with open("README.md", "r", encoding="utf-8") as fh:
+    long_description = fh.read()
+
+setup(
+    name="tako-sdk",
+    version="0.1.4",
+    author="Tako",
+    author_email="support@trytako.com",
+    description="A Python SDK for interacting with the Tako API",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    package_dir={"": "src"},
+    packages=find_packages(where="src"),
+    python_requires=">=3.9",
+    install_requires=[
+        "pydantic==2.8.2",
+        "pytest==7.4.3",
+        "requests==2.32.3",
+    ],
+    license="MIT",
+) 

tako_sdk-0.1.4/src/tako/client.py

@@ -0,0 +1,52 @@
+from typing import List, Optional
+import requests
+
+from tako.types.common.errors import BaseAPIError
+from tako.types.common.exceptions import raise_exception_from_error
+from tako.types.knowledge_search.types import KnowledgeSearchResults, KnowledgeSearchSourceIndex
+
+DEFAULT_SERVER_URL = "https://trytako.com/"
+DEFAULT_API_VERSION = "v1"
+
+class TakoClient:
+    def __init__(self, api_key: str, server_url: Optional[str] = None, api_version: Optional[str] = None):
+        assert api_key is not None, "API key is required"
+        self.api_key = api_key
+        self.server_url = server_url or DEFAULT_SERVER_URL
+        self.api_version = api_version or DEFAULT_API_VERSION
+
+    def knowledge_search(self, text: str, source_indexes: Optional[List[KnowledgeSearchSourceIndex]] = None) -> KnowledgeSearchResults:
+        """
+        Search for knowledge cards based on a text query.
+
+        Args:
+            text: The text to search for.
+            source_indexes: The source indexes to search for.
+
+        Returns:
+            A list of knowledge search results.
+
+        Raises:
+            APIException: If the API returns an error.
+        """
+        url = f"{self.server_url}/api/{self.api_version}/knowledge_search"
+        payload = {
+            "inputs": {
+                "text": text,
+            },
+        }
+        if source_indexes:
+            payload["source_indexes"] = source_indexes
+
+        response = requests.post(url, json=payload, headers={"Authorization": f"Bearer {self.api_key}"})
+        if response.status_code != 200:
+            raise_exception_from_error(BaseAPIError.model_validate(response.json()))
+        return KnowledgeSearchResults.model_validate(response.json())
+    
+    def get_image(self, card_id: str) -> bytes:
+        url = f"{self.server_url}/api/{self.api_version}/image/{card_id}"
+        response = requests.get(url, headers={"Authorization": f"Bearer {self.api_key}"})
+        return response.content
+    
+    
+    

tako_sdk-0.1.4/src/tako/types/common/errors.py

@@ -0,0 +1,46 @@
+from enum import Enum
+from typing import Union
+
+from pydantic import BaseModel
+
+class APIErrorType(str, Enum):
+    BAD_REQUEST = "BAD_REQUEST"
+    AUTHENTICATION_ERROR = "AUTHENTICATION_ERROR"
+    INTERNAL_SERVER_ERROR = "INTERNAL_SERVER_ERROR"
+    RELEVANT_RESULTS_NOT_FOUND = "RELEVANT_RESULTS_NOT_FOUND"
+    RATE_LIMIT_EXCEEDED = "RATE_LIMIT_EXCEEDED"
+    PAYMENT_REQUIRED = "PAYMENT_REQUIRED"
+
+
+class BaseAPIError(BaseModel):
+    error_message: str
+    error_type: APIErrorType
+
+
+class AuthenticationError(BaseAPIError):
+    error_type: APIErrorType = APIErrorType.AUTHENTICATION_ERROR
+
+
+class BadRequestError(BaseAPIError):
+    error_type: APIErrorType = APIErrorType.BAD_REQUEST
+
+
+class InternalServerError(BaseAPIError):
+    error_type: APIErrorType = APIErrorType.INTERNAL_SERVER_ERROR
+
+
+class RelevantResultsNotFoundError(BaseAPIError):
+    error_type: APIErrorType = APIErrorType.RELEVANT_RESULTS_NOT_FOUND
+
+
+class RateLimitExceededError(BaseAPIError):
+    error_type: APIErrorType = APIErrorType.RATE_LIMIT_EXCEEDED
+
+
+class PaymentRequiredError(BaseAPIError):
+    error_type: APIErrorType = APIErrorType.PAYMENT_REQUIRED
+
+
+APIError = Union[PaymentRequiredError, RateLimitExceededError, RelevantResultsNotFoundError, InternalServerError, AuthenticationError, BadRequestError]
+
+

tako_sdk-0.1.4/src/tako/types/common/exceptions.py

@@ -0,0 +1,78 @@
+from typing import Union
+from tako.types.common.errors import (
+    APIErrorType,
+    BaseAPIError,
+    RateLimitExceededError,
+    RelevantResultsNotFoundError,
+    PaymentRequiredError,
+    AuthenticationError,
+    BadRequestError,
+    InternalServerError
+)
+
+class RelevantResultsNotFoundException(Exception):
+    def __init__(self, error: RelevantResultsNotFoundError):
+        self.error = error
+
+    def __str__(self):
+        return self.error.error_message
+    
+class RateLimitExceededException(Exception):
+    def __init__(self, error: RateLimitExceededError):
+        self.error = error
+
+    def __str__(self):
+        return self.error.error_message
+
+class PaymentRequiredException(Exception):
+    def __init__(self, error: PaymentRequiredError):
+        self.error = error
+
+    def __str__(self):
+        return self.error.error_message
+
+class AuthenticationErrorException(Exception):
+    def __init__(self, error: AuthenticationError):
+        self.error = error
+
+    def __str__(self):
+        return self.error.error_message
+
+class BadRequestException(Exception):
+    def __init__(self, error: BadRequestError):
+        self.error = error
+
+    def __str__(self):
+        return self.error.error_message
+
+class InternalServerErrorException(Exception):
+    def __init__(self, error: InternalServerError):
+        self.error = error
+
+    def __str__(self):
+        return self.error.error_message
+    
+
+APIException = Union[PaymentRequiredException, RateLimitExceededException, RelevantResultsNotFoundException, InternalServerErrorException, AuthenticationErrorException, BadRequestException]
+
+def raise_exception_from_error(error: BaseAPIError):
+    """
+    Raise the appropriate exception based on the error type.
+
+    Python 3.9 does not support match statements so we need to do it this way.
+    """
+    if error.error_type == APIErrorType.PAYMENT_REQUIRED:
+        raise PaymentRequiredException(error)
+    elif error.error_type == APIErrorType.RATE_LIMIT_EXCEEDED:
+        raise RateLimitExceededException(error)
+    elif error.error_type == APIErrorType.RELEVANT_RESULTS_NOT_FOUND:
+        raise RelevantResultsNotFoundException(error)
+    elif error.error_type == APIErrorType.INTERNAL_SERVER_ERROR:
+        raise InternalServerErrorException(error)
+    elif error.error_type == APIErrorType.AUTHENTICATION_ERROR:
+        raise AuthenticationErrorException(error)
+    elif error.error_type == APIErrorType.BAD_REQUEST:
+        raise BadRequestException(error)
+    else:
+        raise ValueError(f"Unknown error type: {error.error_type}")
+

tako_sdk-0.1.4/src/tako/types/knowledge_search/types.py

@@ -0,0 +1,143 @@
+from enum import Enum
+from typing import List, Optional
+
+from pydantic import BaseModel, Field
+
+####
+# This file contains the types for the knowledge search API
+####
+
+
+class KnowledgeSearchSourceIndex(str, Enum):
+    TAKO = "tako"
+    WEB = "web"
+
+
+class KnowledgeSearchInputs(BaseModel):
+    text: Optional[str] = Field(
+        description="Natural language search query string. This can be a direct knowledge query, "
+        "or long form text, for which relevant knowledge cards should be returned.",
+        examples=[
+            "AMD vs. Nvidia headcount since 2013",
+            "What is the population of the United States?",
+        ],
+    )
+
+
+class KnowledgeCardSource(BaseModel):
+    source_name: Optional[str] = Field(
+        description="The name of the source",
+        examples=["S&P Global", "The World Bank"],
+    )
+    source_description: Optional[str] = Field(
+        description="The description of the source",
+        examples=[
+            "S&P Global is a US-based financial data and analytics company that provides "
+            "products and services to the financial industry.",
+            "The World Bank is an international financial institution that provides "
+            "financial and technical assistance to developing countries to help them "
+            "achieve sustainable economic growth and improve living conditions.",
+        ],
+    )
+    source_index: KnowledgeSearchSourceIndex = Field(
+        description="The index of the source",
+        examples=[KnowledgeSearchSourceIndex.TAKO, KnowledgeSearchSourceIndex.WEB],
+    )
+    url: Optional[str] = Field(
+        description="The URL of the source",
+        examples=["https://xignite.com", "https://stats.com"],
+    )
+
+    def __hash__(self) -> int:
+        return hash(
+            (self.source_name, self.source_description, self.source_index, self.url)
+        )
+
+
+class KnowledgeCardMethodology(BaseModel):
+    methodology_name: Optional[str] = Field(
+        description="The name of the methodology",
+        examples=["Change me"],  # TODO
+    )
+    methodology_description: Optional[str] = Field(
+        description="The description of the methodology",
+        examples=["Change me"],  # TODO
+    )
+
+    def __hash__(self) -> int:
+        return hash((self.methodology_name, self.methodology_description))
+
+
+class KnowledgeCard(BaseModel):
+    card_id: Optional[str] = Field(
+        description="The unique ID of the knowledge card",
+        examples=["08OoYXQeAjCs_8ybek96"],
+    )
+    title: Optional[str] = Field(
+        description="The title of the knowledge card",
+        examples=["Nvidia, Advanced Micro Devices - Full Time Employees"],
+    )
+    description: Optional[str] = Field(
+        description="The description of the knowledge card",
+        examples=[
+            "This is a time series bar chart showing 2 series between 12:00AM UTC-04:00 on "
+            "04/01/2013 and 08:55PM UTC on 04/30/2025. Nvidia Full Time Employees latest "
+            "value was at 12:00AM UTC on 12-31-2024, and had a final value of 36.0K "
+            "Employees, or 308.72% growth since 12:00AM UTC on 12-31-2013, with a maximum "
+            "value of 36.0K Employees at 12:00AM UTC on 12-31-2024 and a minimum value of "
+            "8.81K Employees at 12:00AM UTC on 12-31-2013; Advanced Micro Devices Full Time "
+            "Employees latest value was at 12:00AM UTC on 12-31-2024, and had a final value "
+            "of 28.0K Employees, or 162.39% growth since 12:00AM UTC on 12-31-2013, with a "
+            "maximum value of 28.0K Employees at 12:00AM UTC on 12-31-2024 and a minimum "
+            "value of 8.2K Employees at 12:00AM UTC on 12-31-2016. The source of the data "
+            "is S&P Global. S&P Global is a US-based financial data and analytics company "
+            "that provides products and services to the financial industry.",
+        ],
+    )
+    webpage_url: Optional[str] = Field(
+        description="URL of a webpage hosting the interactive knowledge card",
+        examples=["https://trytako.com/card/08OoYXQeAjCs_8ybek96/"],
+    )
+    image_url: Optional[str] = Field(
+        description="URL of a static image of the knowledge card",
+        examples=["https://trytako.com/api/v1/image/08OoYXQeAjCs_8ybek96/"],
+    )
+    embed_url: Optional[str] = Field(
+        description="URL of an embeddable iframe of the knowledge card",
+        examples=["https://trytako.com/embed/08OoYXQeAjCs_8ybek96/"],
+    )
+    sources: Optional[List[KnowledgeCardSource]] = Field(
+        description="The sources of the knowledge card",
+    )
+    methodologies: Optional[List[KnowledgeCardMethodology]] = Field(
+        description="The methodologies of the knowledge card",
+    )
+    source_indexes: Optional[List[KnowledgeSearchSourceIndex]] = Field(
+        description="The source indexes of the knowledge card",
+    )
+
+
+class KnowledgeSearchOutputs(BaseModel):
+    knowledge_cards: Optional[List[KnowledgeCard]] = None
+
+
+class KnowledgeSearchResults(BaseModel):
+    outputs: Optional[KnowledgeSearchOutputs] = None
+    request_id: Optional[str] = None
+
+
+class KnowledgeSearchRequest(BaseModel):
+    inputs: Optional[KnowledgeSearchInputs] = Field(
+        description="The inputs for the knowledge search request"
+    )
+
+    # Priority order of potential source indexes to search
+    # Once relevant results are found in a source index, the search will stop
+    # and results from remaining source indexes will not be searched
+    source_indexes: Optional[List[KnowledgeSearchSourceIndex]] = Field(
+        description="The priority order of potential source indexes to search."
+        "Once relevant results are found in a source index, the search will stop"
+        "and results from remaining source indexes will not be searched."
+        "Valid values are: tako, web",
+        default=[KnowledgeSearchSourceIndex.TAKO],
+    )

tako_sdk-0.1.4/src/tako_sdk.egg-info/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: tako-sdk
+Version: 0.1.4
+Summary: A Python SDK for interacting with the Tako API
+Author: Tako
+Author-email: support@trytako.com
+License: MIT
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pydantic==2.8.2
+Requires-Dist: pytest==7.4.3
+Requires-Dist: requests==2.32.3
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Tako Python SDK 
+
+The Tako Python SDK is a Python library that makes it easy for applications to use the Tako Knowledge Search API
+
+## Requirements
+
+The Tako Python SDK supports Python 3.9+
+
+## Installation
+
+```bash
+pip install tako-sdk
+```
+
+## Testing
+```bash
+export TAKO_API_KEY=<your-tako-server-api-key>
+export TAKO_SERVER_URL=<tako-server-url>
+pytest tests/integration/ -v
+```
+
+## Contributions
+
+This repo is currently maintained by Tako developers. As we evolve this repo, contributors outside of
+Tako will be welcome and developer guides added.
+
+## Support
+
+For support, please [create an issue](https://github.com/[organization]/tako-sdk/issues) in our GitHub repository. 

tako_sdk-0.1.4/src/tako_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,15 @@
+README.md
+setup.py
+src/tako/__init__.py
+src/tako/client.py
+src/tako/types/__init__.py
+src/tako/types/common/__init__.py
+src/tako/types/common/errors.py
+src/tako/types/common/exceptions.py
+src/tako/types/knowledge_search/__init__.py
+src/tako/types/knowledge_search/types.py
+src/tako_sdk.egg-info/PKG-INFO
+src/tako_sdk.egg-info/SOURCES.txt
+src/tako_sdk.egg-info/dependency_links.txt
+src/tako_sdk.egg-info/requires.txt
+src/tako_sdk.egg-info/top_level.txt

tako_sdk-0.1.4/src/tako_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tako_sdk-0.1.4/src/tako_sdk.egg-info/requires.txt

@@ -0,0 +1,3 @@
+pydantic==2.8.2
+pytest==7.4.3
+requests==2.32.3

tako_sdk-0.1.4/src/tako_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+tako