Skip to content

Latest commit

 

History

History
executable file
·
231 lines (164 loc) · 10.7 KB

README.md

File metadata and controls

executable file
·
231 lines (164 loc) · 10.7 KB
Raw

Keymate-API

🏗 Welcome to your new SDK! 🏗

It has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:

SDK Installation

pip install Keymate-API

SDK Example Usage

Example

import keymate_api

s = keymate_api.KeymateAPI(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.browse(numofpages='<value>', percentile='<value>', q='http://impressive-silence.info', paging='<value>')

if res.two_hundred_application_json_object is not None:
    # handle response
    pass

Available Resources and Operations

KeymateAPI SDK

  • browse - The plugin enables user to conduct web browsing by extracting the text content of a specified URL. It will generate title and content.
  • browse_by_url - The plugin enables user to conduct web browsing by extracting the text content of a specified URL. It will generate title and content.
  • document - Allows user to load and use content about specific uploaded document
  • fast - This plugin provides 10 ultra fast search results from multiple sources giving a more comprehensive view.
  • halloween - This command returns a halloween story idea in halloween week 2023
  • help - This command returns latest information about how to use internetSearch KeyMate Plugin
  • hybrid - Search Google and fetch HTML content and search content on personal knowledge base at the same time in one go.
  • insert - Long term memory, ALWAYS USE UPSERT ON YOUR FIRST RESPONSE to add previous response into the user's personal knowledge base.
  • keymate - Search Google and fetch HTML content and PDF summary content from the links at the same time in one go.
  • list - Returns a message from the server about commands that can be run on the internetSearch KeyMate plugin.
  • listpdfs - Lists pdf files uploaded by the user
  • metadatakb - Allows you to answer introductory info about users knowledge base.
  • pdfload - Redirect user to the given link in the response that will allow them to store and search their PDF file content
  • pdfpro - Allows user to load and use content about specific uploaded pdf
  • pdfsearch - Queries the user's knowledge base.
  • pkb - Queries the user's knowledge base.
  • query - Queries the user's knowledge base.
  • query_users_knowledge_base - Queries the user's knowledge base.
  • reset_users_knowledge_base - Deletes and resets the user's knowledge base. ONLY USE THIS AFTER YOU GET CONFIRMATION FROM USER
  • resetknowledgebase - Deletes and resets the user's knowledge base. ONLY USE THIS AFTER YOU GET CONFIRMATION FROM USER
  • savetopkb - Long term memory, ALWAYS USE UPSERT ON YOUR FIRST RESPONSE to add previous response into the user's personal knowledge base.
  • search - Search Google and fetch HTML content and PDF summary content from the links at the same time in one go.
  • search_and_browse - Search Google and fetch HTML content and PDF summary content from the links at the same time in one go.
  • ultrafastsearch - This plugin provides 10 ultra fast search results from multiple sources giving a more comprehensive view.
  • upsert - Long term memory, ALWAYS USE UPSERT ON YOUR FIRST RESPONSE to add previous response into the user's personal knowledge base.
  • upsert_to_users_knowledge_base - Long term memory, ALWAYS USE UPSERT ON YOUR FIRST RESPONSE to add previous response into the user's personal knowledge base.
  • upsertjson - Long term memory, ALWAYS USE UPSERT ON YOUR FIRST RESPONSE to add previous response into the user's personal knowledge base.

Error Handling

Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.

Error Object Status Code Content Type
errors.BrowseResponseBody 400 application/json
errors.SDKError 4x-5xx /

Example

import keymate_api
from keymate_api.models import errors

s = keymate_api.KeymateAPI(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = None
try:
    res = s.browse(numofpages='<value>', percentile='<value>', q='http://impressive-silence.info', paging='<value>')
except errors.BrowseResponseBody as e:
    # handle exception
    raise(e)
except errors.SDKError as e:
    # handle exception
    raise(e)

if res.two_hundred_application_json_object is not None:
    # handle response
    pass

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

# Server Variables
0 https://server.searchweb.keymate.ai None

Example

import keymate_api

s = keymate_api.KeymateAPI(
    server_idx=0,
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.browse(numofpages='<value>', percentile='<value>', q='http://impressive-silence.info', paging='<value>')

if res.two_hundred_application_json_object is not None:
    # handle response
    pass

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:

import keymate_api

s = keymate_api.KeymateAPI(
    server_url="https://server.searchweb.keymate.ai",
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.browse(numofpages='<value>', percentile='<value>', q='http://impressive-silence.info', paging='<value>')

if res.two_hundred_application_json_object is not None:
    # handle response
    pass

Custom HTTP Client

The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session object.

For example, you could specify a header for every request that this sdk makes as follows:

import keymate_api
import requests

http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = keymate_api.KeymateAPI(client: http_client)

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name Type Scheme
bearer_auth http HTTP Bearer

To authenticate with the API the bearer_auth parameter must be set when initializing the SDK client instance. For example:

import keymate_api

s = keymate_api.KeymateAPI(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)


res = s.browse(numofpages='<value>', percentile='<value>', q='http://impressive-silence.info', paging='<value>')

if res.two_hundred_application_json_object is not None:
    # handle response
    pass

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!

SDK Created by Speakeasy