camel-ai 0.1.5.1__py3-none-any.whl → 0.1.5.3__py3-none-any.whl

camel/functions/open_api_function.py

@@ -13,16 +13,15 @@
 # =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
 import json
 import os
-from typing import Any, Callable, Dict, List, Tuple
+from typing import Any, Callable, Dict, List, Optional, Tuple
 
-import prance
 import requests
 
-from camel.functions import OpenAIFunction
+from camel.functions import OpenAIFunction, openapi_security_config
 from camel.types import OpenAPIName
 
 
-def parse_openapi_file(openapi_spec_path: str) -> Dict[str, Any]:
+def parse_openapi_file(openapi_spec_path: str) -> Optional[Dict[str, Any]]:
     r"""Load and parse an OpenAPI specification file.
 
     This function utilizes the `prance.ResolvingParser` to parse and resolve
@@ -34,11 +33,30 @@ def parse_openapi_file(openapi_spec_path: str) -> Dict[str, Any]:
             specification.
 
     Returns:
-        Dict[str, Any]: The parsed OpenAPI specification as a dictionary.
+        Optional[Dict[str, Any]]: The parsed OpenAPI specification
+            as a dictionary. :obj:`None` if the package is not installed.
     """
+    try:
+        import prance
+    except Exception:
+        return None
+
     # Load the OpenAPI spec
-    parser = prance.ResolvingParser(openapi_spec_path)
+    parser = prance.ResolvingParser(
+        openapi_spec_path, backend="openapi-spec-validator", strict=False
+    )
     openapi_spec = parser.specification
+    version = openapi_spec.get('openapi', {})
+    if not version:
+        raise ValueError(
+            "OpenAPI version not specified in the spec. "
+            "Only OPENAPI 3.0.x and 3.1.x are supported."
+        )
+    if not (version.startswith('3.0') or version.startswith('3.1')):
+        raise ValueError(
+            f"Unsupported OpenAPI version: {version}. "
+            f"Only OPENAPI 3.0.x and 3.1.x are supported."
+        )
     return openapi_spec
 
 
@@ -176,22 +194,33 @@ def openapi_spec_to_openai_schemas(
 
 
 def openapi_function_decorator(
-    base_url: str, path: str, method: str, operation: Dict[str, Any]
+    api_name: str,
+    base_url: str,
+    path: str,
+    method: str,
+    openapi_security: List[Dict[str, Any]],
+    sec_schemas: Dict[str, Dict[str, Any]],
+    operation: Dict[str, Any],
 ) -> Callable:
-    r"""Decorate a function to make HTTP requests based on OpenAPI operation
-    details.
+    r"""Decorate a function to make HTTP requests based on OpenAPI
+    specification details.
 
-    This decorator takes the base URL, path, HTTP method, and operation details
-    from an OpenAPI specification, and returns a decorator. The decorated
-    function can then be called with keyword arguments corresponding to the
-    operation's parameters. The decorator handles constructing the request URL,
-    setting headers, query parameters, and the request body as specified by the
-    operation details.
+    This decorator dynamically constructs and executes an API request based on
+    the provided OpenAPI operation specifications, security requirements, and
+    parameters.  It supports operations secured with `apiKey` type security
+    schemes and automatically injects the necessary API keys from environment
+    variables. Parameters in `path`, `query`, `header`, and `cookie` are also
+    supported.
 
     Args:
+        api_name (str): The name of the API, used to retrieve API key names
+            and URLs from the configuration.
         base_url (str): The base URL for the API.
         path (str): The path for the API endpoint, relative to the base URL.
         method (str): The HTTP method (e.g., 'get', 'post') for the request.
+        openapi_security (List[Dict[str, Any]]): The global security
+            definitions as specified in the OpenAPI specs.
+        sec_schemas (Dict[str, Dict[str, Any]]): Detailed security schemes.
         operation (Dict[str, Any]): A dictionary containing the OpenAPI
             operation details, including parameters and request body
             definitions.
@@ -200,6 +229,12 @@ def openapi_function_decorator(
         Callable: A decorator that, when applied to a function, enables the
             function to make HTTP requests based on the provided OpenAPI
             operation details.
+
+    Raises:
+        TypeError: If the security requirements include unsupported types.
+        ValueError: If required API keys are missing from environment
+            variables or if the content type of the request body is
+            unsupported.
     """
 
     def inner_decorator(openapi_function: Callable) -> Callable:
@@ -209,6 +244,51 @@ def openapi_function_decorator(
             params = {}
             cookies = {}
 
+            # Security definition of operation overrides any declared
+            # top-level security.
+            sec_requirements = operation.get('security', openapi_security)
+            avail_sec_requirement = {}
+            # Write to avaliable_security_requirement only if all the
+            # security_type are "apiKey"
+            for security_requirement in sec_requirements:
+                have_unsupported_type = False
+                for sec_scheme_name, _ in security_requirement.items():
+                    sec_type = sec_schemas.get(sec_scheme_name).get('type')
+                    if sec_type != "apiKey":
+                        have_unsupported_type = True
+                        break
+                if have_unsupported_type is False:
+                    avail_sec_requirement = security_requirement
+                    break
+
+            if sec_requirements and not avail_sec_requirement:
+                raise TypeError(
+                    "Only security schemas of type `apiKey` are supported."
+                )
+
+            for sec_scheme_name, _ in avail_sec_requirement.items():
+                try:
+                    API_KEY_NAME = openapi_security_config.get(api_name).get(
+                        sec_scheme_name
+                    )
+                    api_key_value = os.environ[API_KEY_NAME]
+                except Exception:
+                    api_key_url = openapi_security_config.get(api_name).get(
+                        'get_api_key_url'
+                    )
+                    raise ValueError(
+                        f"`{API_KEY_NAME}` not found in environment "
+                        f"variables. Get `{API_KEY_NAME}` here: {api_key_url}"
+                    )
+                request_key_name = sec_schemas.get(sec_scheme_name).get('name')
+                request_key_in = sec_schemas.get(sec_scheme_name).get('in')
+                if request_key_in == 'query':
+                    params[request_key_name] = api_key_value
+                elif request_key_in == 'header':
+                    headers[request_key_name] = api_key_value
+                elif request_key_in == 'coolie':
+                    cookies[request_key_name] = api_key_value
+
             # Assign parameters to the correct position
             for param in operation.get('parameters', []):
                 input_param_name = param['name'] + '_in_' + param['in']
@@ -307,6 +387,10 @@ def generate_openapi_funcs(
         raise ValueError("No server information found in OpenAPI spec.")
     base_url = servers[0].get('url')  # Use the first server URL
 
+    # Security requirement objects for all methods
+    openapi_security = openapi_spec.get('security', {})
+    # Security schemas which can be reused by different methods
+    sec_schemas = openapi_spec.get('components', {}).get('securitySchemes', {})
     functions = []
 
     # Traverse paths and methods
@@ -321,7 +405,15 @@ def generate_openapi_funcs(
                 sanitized_path = path.replace('/', '_').strip('_')
                 function_name = f"{api_name}_{method}_{sanitized_path}"
 
-            @openapi_function_decorator(base_url, path, method, operation)
+            @openapi_function_decorator(
+                api_name,
+                base_url,
+                path,
+                method,
+                openapi_security,
+                sec_schemas,
+                operation,
+            )
             def openapi_function(**kwargs):
                 pass
 
@@ -332,13 +424,22 @@ def generate_openapi_funcs(
     return functions
 
 
-def combine_all_funcs_schemas() -> Tuple[List[Callable], List[Dict[str, Any]]]:
-    r"""Combines functions and schemas from multiple OpenAPI specifications.
+def apinames_filepaths_to_funs_schemas(
+    apinames_filepaths: List[Tuple[str, str]],
+) -> Tuple[List[Callable], List[Dict[str, Any]]]:
+    r"""Combines functions and schemas from multiple OpenAPI specifications,
+    using API names as keys.
+
+    This function iterates over tuples of API names and OpenAPI spec file
+    paths, parsing each spec to generate callable functions and schema
+    dictionaries, all organized by API name.
 
-    Iterates over a list of OpenAPI specs, parses each, and generates functions
-    and schemas based on the defined operations and schemas respectively.
-    Assumes specification files are named 'openapi.yaml' located in
-    `open_api_specs/<api_name>/`.
+    Args:
+    apinames_filepaths (List[Tuple[str, str]]): A list of tuples, where each
+        tuple consists of:
+        - The API name (str) as the first element.
+        - The file path (str) to the API's OpenAPI specification file as the
+            second element.
 
     Returns:
         Tuple[List[Callable], List[Dict[str, Any]]]:: one of callable
@@ -347,34 +448,61 @@ def combine_all_funcs_schemas() -> Tuple[List[Callable], List[Dict[str, Any]]]:
     """
     combined_func_lst = []
     combined_schemas_list = []
-
-    for api_name in OpenAPIName:
+    for api_name, file_path in apinames_filepaths:
         # Parse the OpenAPI specification for each API
         current_dir = os.path.dirname(__file__)
-        spec_file_path = os.path.join(
-            current_dir, 'open_api_specs', f'{api_name.value}', 'openapi.yaml'
+        file_path = os.path.join(
+            current_dir, 'open_api_specs', f'{api_name}', 'openapi.yaml'
         )
 
-        openapi_spec = parse_openapi_file(spec_file_path)
+        openapi_spec = parse_openapi_file(file_path)
+        if openapi_spec is None:
+            return [], []
 
         # Generate and merge function schemas
         openapi_functions_schemas = openapi_spec_to_openai_schemas(
-            api_name.value, openapi_spec
+            api_name, openapi_spec
         )
         combined_schemas_list.extend(openapi_functions_schemas)
 
         # Generate and merge function lists
-        openapi_functions_list = generate_openapi_funcs(
-            api_name.value, openapi_spec
-        )
+        openapi_functions_list = generate_openapi_funcs(api_name, openapi_spec)
         combined_func_lst.extend(openapi_functions_list)
 
     return combined_func_lst, combined_schemas_list
 
 
-combined_funcs_lst, combined_schemas_list = combine_all_funcs_schemas()
+def generate_apinames_filepaths() -> List[Tuple[str, str]]:
+    """Generates a list of tuples containing API names and their corresponding
+    file paths.
+
+    This function iterates over the OpenAPIName enum, constructs the file path
+    for each API's OpenAPI specification file, and appends a tuple of the API
+    name and its file path to the list. The file paths are relative to the
+    'open_api_specs' directory located in the same directory as this script.
+
+    Returns:
+        List[Tuple[str, str]]: A list of tuples where each tuple contains two
+            elements. The first element of each tuple is a string representing
+            the name of an API, and the second element is a string that
+            specifies the file path to that API's OpenAPI specification file.
+    """
+    apinames_filepaths = []
+    current_dir = os.path.dirname(__file__)
+    for api_name in OpenAPIName:
+        file_path = os.path.join(
+            current_dir, 'open_api_specs', f'{api_name.value}', 'openapi.yaml'
+        )
+        apinames_filepaths.append((api_name.value, file_path))
+    return apinames_filepaths
+
+
+apinames_filepaths = generate_apinames_filepaths()
+all_funcs_lst, all_schemas_lst = apinames_filepaths_to_funs_schemas(
+    apinames_filepaths
+)
 
 OPENAPI_FUNCS: List[OpenAIFunction] = [
     OpenAIFunction(a_func, a_schema)
-    for a_func, a_schema in zip(combined_funcs_lst, combined_schemas_list)
+    for a_func, a_schema in zip(all_funcs_lst, all_schemas_lst)
 ]

camel/functions/open_api_specs/biztoc/__init__.py

@@ -0,0 +1,13 @@
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+# Licensed under the Apache License, Version 2.0 (the “License”);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an “AS IS” BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========

camel/functions/open_api_specs/biztoc/ai-plugin.json

@@ -0,0 +1,34 @@
+{
+  "id": "plugin-da9afb50-fc07-4d30-b606-51ed1b105bfc",
+  "domain": "biztoc.com",
+  "namespace": "biztoc",
+  "status": "approved",
+  "manifest": {
+    "schema_version": "v1",
+    "name_for_model": "biztoc",
+    "name_for_human": "BizToc",
+    "description_for_model": "Plugin for querying BizToc for business news.",
+    "description_for_human": "Search BizToc for business & finance news.",
+    "auth": {
+      "type": null
+    },
+    "api": {
+      "type": "openapi",
+      "url": "https://ai.biztoc.com/openapi.yaml"
+    },
+    "logo_url": "https://biztoc.com/favicon.png",
+    "contact_email": "mail@biztoc.com",
+    "legal_info_url": "https://biztoc.com/s/legal"
+  },
+  "oauth_client_id": null,
+  "user_settings": {
+    "is_installed": false,
+    "is_authenticated": true
+  },
+  "categories": [
+    {
+      "id": "newly_added",
+      "title": "New"
+    }
+  ]
+}

camel/functions/open_api_specs/biztoc/openapi.yaml

@@ -0,0 +1,21 @@
+openapi: 3.0.1
+info:
+  title: BizToc
+  description: Search BizToc for business & finance news.
+  version: 'v1'
+servers:
+  - url: https://ai.biztoc.com
+paths:
+  /ai/news:
+    get:
+      operationId: getNews
+      summary: Retrieves the latest news whose content contains the query string.
+      parameters:
+      - in: query
+        name: query
+        schema:
+            type: string
+        description: Used to query news articles on their title and body. For example, ?query=apple will return news stories that have 'apple' in their title or body.
+      responses:
+        "200":
+          description: OK

camel/functions/open_api_specs/create_qr_code/__init__.py

@@ -0,0 +1,13 @@
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+# Licensed under the Apache License, Version 2.0 (the “License”);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an “AS IS” BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========

camel/functions/open_api_specs/create_qr_code/openapi.yaml

@@ -0,0 +1,44 @@
+openapi: 3.0.1
+info:
+  title: QR Code API
+  version: 1.0.0
+  description: Create a QR code for any text or url.
+servers:
+  - url: https://create-qr-code.modelxy.com
+paths:
+  /create-qr-code:
+    get:
+      operationId: getQRCode
+      summary: Create a QR code
+      parameters:
+        - in: query
+          name: data
+          schema:
+            type: string
+          description: The data to encode in the QR code.
+        - in: query
+          name: size
+          schema:
+            type: string
+            default: '100x100'
+          description: The size of the QR code.
+        - in: query
+          name: alt
+          schema:
+            type: string
+          description: The alt text for the QR code image.
+        - in: query
+          name: title
+          schema:
+            type: string
+          description: The title for the QR code image.
+      responses:
+        '200':
+          description: A JSON object containing the QR code image tag.
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  img_tag:
+                    type: string

camel/functions/open_api_specs/nasa_apod/__init__.py

@@ -0,0 +1,13 @@
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+# Licensed under the Apache License, Version 2.0 (the “License”);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an “AS IS” BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========

camel/functions/open_api_specs/nasa_apod/openapi.yaml

@@ -0,0 +1,72 @@
+openapi: 3.0.0
+servers:
+  - url: https://api.nasa.gov/planetary
+  - url: http://api.nasa.gov/planetary
+info:
+  contact:
+    email: evan.t.yates@nasa.gov
+  description: This endpoint structures the APOD imagery and associated metadata
+    so that it can be repurposed for other applications. In addition, if the
+    concept_tags parameter is set to True, then keywords derived from the image
+    explanation are returned. These keywords could be used as auto-generated
+    hashtags for twitter or instagram feeds; but generally help with
+    discoverability of relevant imagery
+  license:
+    name: Apache 2.0
+    url: http://www.apache.org/licenses/LICENSE-2.0.html
+  title: APOD
+  version: 1.0.0
+  x-apisguru-categories:
+    - media
+    - open_data
+  x-origin:
+    - format: swagger
+      url: https://raw.githubusercontent.com/nasa/api-docs/gh-pages/assets/json/APOD
+      version: "2.0"
+  x-providerName: nasa.gov
+  x-serviceName: apod
+tags:
+  - description: An example tag
+    externalDocs:
+      description: Here's a link
+      url: https://example.com
+    name: request tag
+paths:
+  /apod:
+    get:
+      description: Returns the picture of the day
+      parameters:
+        - description: The date of the APOD image to retrieve
+          in: query
+          name: date
+          required: false
+          schema:
+            type: string
+        - description: Retrieve the URL for the high resolution image
+          in: query
+          name: hd
+          required: false
+          schema:
+            type: boolean
+      responses:
+        "200":
+          content:
+            application/json:
+              schema:
+                items:
+                  x-thing: ok
+                type: array
+          description: successful operation
+        "400":
+          description: Date must be between Jun 16, 1995 and Mar 28, 2019.
+      security:
+        - api_key: []
+      summary: Returns images
+      tags:
+        - request tag
+components:
+  securitySchemes:
+    api_key:
+      in: query
+      name: api_key
+      type: apiKey

camel/functions/open_api_specs/outschool/__init__.py

@@ -0,0 +1,13 @@
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+# Licensed under the Apache License, Version 2.0 (the “License”);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an “AS IS” BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========

camel/functions/open_api_specs/outschool/ai-plugin.json

@@ -0,0 +1,34 @@
+{
+    "id": "plugin-9335c256-4658-4376-bac8-a0baa5c1c889",
+    "domain": "chatgpt-plugin.outschool.com",
+    "namespace": "Outschool",
+    "status": "approved",
+    "manifest": {
+        "schema_version": "v1",
+        "name_for_model": "Outschool",
+        "name_for_human": "Outschool",
+        "description_for_model": "Search for top-quality online classes and teachers on Outschool.",
+        "description_for_human": "Search for top-quality online classes and teachers on Outschool.",
+        "auth": {
+            "type": "none"
+        },
+        "api": {
+            "type": "openapi",
+            "url": "https://chatgpt-plugin.outschool.com/openapi.json"
+        },
+        "logo_url": "https://chatgpt-plugin.outschool.com/logo.png",
+        "contact_email": "support@outschool.com",
+        "legal_info_url": "https://outschool.com/terms"
+    },
+    "oauth_client_id": null,
+    "user_settings": {
+        "is_installed": false,
+        "is_authenticated": true
+    },
+    "categories": [
+        {
+            "id": "newly_added",
+            "title": "New"
+        }
+    ]
+}

camel/functions/open_api_specs/outschool/openapi.yaml

@@ -0,0 +1 @@
+{"openapi":"3.0.1","info":{"title":"Outschool Plugin","description":"Search for top-quality online classes and teachers on Outschool.","version":"v1"},"servers":[{"url":"https://chatgpt-plugin.outschool.com/api"}],"paths":{"/classes":{"get":{"operationId":"searchClasses","description":"Returns a list of online classes","parameters":[{"name":"timeZone","in":"query","required":true,"description":"IANA Time Zone identifier of the user. Either provided by user or derived from their location. Since Outschool parents and teachers can be from different time zones, this is required to search classes that are available in parent's timezone at reasonable hours. Only IANA format is accepted.","schema":{"type":"string"},"examples":{"losAngeles":{"value":"America/Los_Angeles"},"newYork":{"value":"America/New_York"},"london":{"value":"Europe/London"}}},{"name":"age","in":"query","required":true,"description":"Outschool has several classes serving different age groups. The age of the learner(s) helps to find classes that match the best. This is a comma separated list. If the age difference between the children is more than 5 years, it may be better to search for different ages separately to get better search results.","schema":{"type":"string","minimum":3,"maximum":18},"examples":{"12":{"value":"12"},"1213":{"value":"12,13"},"5617":{"value":"5,6,17"}}},{"name":"q","in":"query","required":false,"description":"Keywords to use to search in the class list. Classes matching the keyword closest will be returned.","schema":{"type":"string"}},{"name":"delivery","in":"query","required":false,"explode":true,"description":"Filters classes by delivery type. Description for different enum values:\n              One-time: Classes that meets once\n              Ongoing: Weekly classes that learners can enroll in any week\n              Semester course: Multi-week/session classes, usually more than 4 weeks\n              Short course: Multi-week/session classes, usually around 4 weeks\n              Camp: Semester or short courses during summer and school breaks\n              Group: Async chat groups on a specific topic where learners share ideas and experiences, like clubs","schema":{"type":"array","items":{"type":"string","enum":["One-time","Ongoing","Semester course","Short course","Camp","Group"]}}},{"name":"userUid","in":"query","required":false,"description":"Only search classes taught by a specific teacher. The userUid is the id of the teacher","schema":{"type":"string","format":"uuid"}},{"name":"order","in":"query","description":"Sort results by either upcoming, new, or relevance. Upcoming sorts by next section start date in ascending order, new sorts by class published date in descending order, and relevance sorts by the keyword relevance and popularity of the class.","schema":{"type":"string","enum":["upcoming","new","relevance"],"default":"relevance"}},{"name":"offset","in":"query","required":false,"description":"The offset for the results. Offset and limit used in combination to paginate in results. For instance, if limit is 10, to get next 10 results, the offset should be set to 10.","schema":{"type":"number","default":0}},{"name":"limit","in":"query","required":false,"description":"Number of results to return.","schema":{"type":"number","default":10}},{"name":"startAfter","in":"query","required":false,"description":"Search classes that have a section starting on or after a given date. Only today or future dates are allowed.","schema":{"type":"string","format":"date"},"examples":{"April152023":{"value":"2023-04-15"}}},{"name":"dow","in":"query","description":"The day of week to filter classes and only return classes that have a section on given days of the week.","schema":{"type":"array","items":{"type":"string","enum":["Mon","Tue","Wed","Thu","Fri","Sat","Sun"]}},"style":"form","explode":true,"required":false,"examples":{"Mon":{"value":"Mon"},"Mon_Tue":{"value":"Mon,Tue"},"Mon_Thu":{"value":"Mon,Tue,Wed,Thu"},"Weekdays":{"value":"Mon,Tue,Wed,Thu,Fri"},"Weekend":{"value":"Sat, Sun"}}},{"name":"startAfterTime","in":"query","description":"The start time of the class in 24 hour format as hour of the day normalized by the user's timezone","schema":{"type":"number","minimum":6,"maximum":22}},{"name":"endByTime","in":"query","description":"The end time of the class in 24 hour format as hour of the day normalized by the user's timezone","schema":{"type":"number","minimum":6,"maximum":22}}],"responses":{"200":{"description":"A list of classes","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/class"}}}}}}}},"/teachers":{"get":{"operationId":"searchTeachers","description":"Returns a list of teachers","parameters":[{"name":"name","in":"query","required":true,"description":"Name of the teacher to search for","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Number of results to return.","schema":{"type":"number","default":10}}],"responses":{"200":{"description":"A list of teachers","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/teacher"}}}}}}}}},"components":{"schemas":{"class":{"type":"object","properties":{"uid":{"type":"string","format":"uuid","description":"Unique ID of the class in the system that can be used in other API end points"},"title":{"type":"string","description":"Title of the class"},"summary":{"type":"string","description":"Summary of the class"},"url":{"type":"string","format":"uri","description":"URL to the class detail page"},"photo":{"type":"string","format":"uri","description":"Photo of the class"},"is_ongoing_weekly":{"type":"boolean","description":"Whether this class is an ongoing class or not. When a class is an ongoing class, parents can enroll their children for any week of an ongoing class, because the sections of that class meet every week and the weeks don't depend on each other."},"age_min":{"type":"number","description":"The minimum age a learner should be to enroll in the class. Although Outschool has classes for different age groups, individual classes may only be appropriate for a certain age range."},"age_max":{"type":"number","description":"The maximum age a learner should be to enroll in the class. Although Outschool has classes for different age groups, individual classes may only be appropriate for a certain age range."},"teacher":{"$ref":"#/components/schemas/teacher"},"nextSection":{"$ref":"#/components/schemas/section","nullable":true,"description":"The next section of the class that the parent/caregiver can enroll their children in. This is usually what parents are looking for to enroll in a class."}}},"teacher":{"type":"object","properties":{"uid":{"type":"string","format":"uuid","description":"Unique ID of the teacher in the system that can be used in other API end points"},"name":{"type":"string","description":"Name of the teacher"},"about":{"type":"string","description":"A short summary the teacher provides about themselves"},"photo":{"type":"string","format":"uri","description":"Photo of the teacher"},"url":{"type":"string","format":"uri","description":"URL to the Outschool profile page of the teacher"}}},"section":{"type":"object","description":"Sections are what parents enroll their children in for a given class. They are separate cohorts of a class.","properties":{"uid":{"type":"string","format":"uuid","description":"Unique ID of the section in the system that can be used in other API end points"},"url":{"type":"string","format":"uri","description":"URL pointing to the section page"},"start_time":{"type":"string","format":"datetime","description":"The start time for the first meeting of a section."},"end_time":{"type":"string","format":"datetime","description":"The end time for the last meeting of a section."},"size_max":{"type":"number","description":"How many learners can enroll in the section."},"filledSpaceCount":{"type":"number","description":"How many learners are enrolled in the section. size_max - filledSpaceCount gives how many seats are left to enroll in."},"nextOngoingMeeting":{"$ref":"#/components/schemas/meeting","nullable":true,"description":"If the class is an ongoing class, this points to the next meeting for the section."}}},"meeting":{"type":"object","description":"The online meeting for a section. Meetings are held on Zoom.","properties":{"uid":{"type":"string","format":"uuid","description":"Unique ID of the meeting in the system that can be used in other API end points"},"start_time":{"type":"string","format":"datetime","description":"The start time of the meeting."},"end_time":{"type":"string","format":"datetime","description":"The end time of the meeting."}}}}}}

camel/functions/open_api_specs/outschool/paths/__init__.py

@@ -0,0 +1,14 @@
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+# Licensed under the Apache License, Version 2.0 (the “License”);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an “AS IS” BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+path_dict = {"get_classes": "/classes", "search_teachers": "/teachers"}

camel/functions/open_api_specs/outschool/paths/get_classes.py

@@ -0,0 +1,29 @@
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+# Licensed under the Apache License, Version 2.0 (the “License”);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an “AS IS” BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+"""Get classes from Outschool API."""
+
+from typing import Any, Dict
+
+import requests
+
+
+def call_api(input_json: Dict[str, Any]) -> Dict[str, Any]:
+    response = requests.get(
+        "https://chatgpt-plugin.outschool.com/api/classes", params=input_json
+    )
+
+    if response.status_code == 200:
+        return response.json()
+    else:
+        return {"status_code": response.status_code, "text": response.text}

camel/functions/open_api_specs/outschool/paths/search_teachers.py

@@ -0,0 +1,29 @@
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+# Licensed under the Apache License, Version 2.0 (the “License”);
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an “AS IS” BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# =========== Copyright 2023 @ CAMEL-AI.org. All Rights Reserved. ===========
+"""Search for teachers on Outschool."""
+
+from typing import Any, Dict
+
+import requests
+
+
+def call_api(input_json: Dict[str, Any]) -> Dict[str, Any]:
+    response = requests.get(
+        "https://chatgpt-plugin.outschool.com/api/teachers", params=input_json
+    )
+
+    if response.status_code == 200:
+        return response.json()
+    else:
+        return {"status_code": response.status_code, "text": response.text}