| Name | KeymateAPI JSON |
| Version |
0.0.4
JSON |
| download |
| home_page | |
| Summary | Python Client SDK Generated by Speakeasy |
| upload_time | 2024-03-18 20:06:29 |
| maintainer | |
| docs_url | None |
| author | Speakeasy |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# KeymateAPI
<div align="left">
<a href="https://speakeasyapi.dev/"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
</a>
</div>
## 🏗 **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:
- [ ] 🛠 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)
- [ ] ♻️ Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)
- [ ] 🎁 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)
- [ ] ✨ When ready to productionize, delete this section from the README
<!-- Start SDK Installation [installation] -->
## SDK Installation
```bash
pip install git+https://github.com/ReminisApp/keymate-python-api.git
```
<!-- End SDK Installation [installation] -->
<!-- Start SDK Example Usage [usage] -->
## SDK Example Usage
### Example
```python
import keymateapi
s = keymateapi.KeymateAPI()
res = s.insertionplan("<YOUR_BEARER_TOKEN_HERE>", q='<value>')
if res.object is not None:
# handle response
pass
```
<!-- End SDK Example Usage [usage] -->
<!-- Start Available Resources and Operations [operations] -->
## Available Resources and Operations
### [KeymateAPI SDK](docs/sdks/keymateapi/README.md)
* [insertionplan](docs/sdks/keymateapi/README.md#insertionplan) - Long term memory information addition plan, run this operation before adding anything to the keymate memory personal knowledge base before /upsert /upsertjson /upserttoUsersKnowledgebase /savetopkb /upsertToUsersKnowledgeBase operations
* [gptsbrowse](docs/sdks/keymateapi/README.md#gptsbrowse) - Only fetch https://memory.keymate.ai URLs with this operation. For other URLs use browseurl operation, never run this more than twice
* [internetsearch](docs/sdks/keymateapi/README.md#internetsearch) - For Search Browsing always start with this operation. Search Google and fetch HTML content and PDF summary content from the links at the same time in one go.
* [browseurl](docs/sdks/keymateapi/README.md#browseurl) - The plugin enables user to conduct web browsing by extracting the text content of a specified URL. It will generate title and content.
* [metadatakb](docs/sdks/keymateapi/README.md#metadatakb) - Allows you to answer introductory info about users Keymate memory.
* [listpdfs](docs/sdks/keymateapi/README.md#listpdfs) - Lists pdf files uploaded by the user
* [ultrafastsearch](docs/sdks/keymateapi/README.md#ultrafastsearch) - This plugin provides 10 ultra fast search results from multiple sources giving a more comprehensive view.
* [upsert](docs/sdks/keymateapi/README.md#upsert) - Long term memory addition operation, ALWAYS USE Call the searchweb.keymate.ai API with the insertionplan operation before running this. Give data insertion plan to user and get confirmation before running this.
* [insert](docs/sdks/keymateapi/README.md#insert) - Long term memory addition operation, ALWAYS USE Call the searchweb.keymate.ai API with the insertionplan operation before running this. Give data insertion plan to user and get confirmation before running this.
* [savetopkb](docs/sdks/keymateapi/README.md#savetopkb) - Long term memory addition operation, ALWAYS USE insertionplan operation before running this. Give data insertion plan to user and get confirmation before running this.
* [upsertjson](docs/sdks/keymateapi/README.md#upsertjson) - Long term memory addition operation, ALWAYS USE Call the searchweb.keymate.ai API with the insertionplan operation before running this. Give data insertion plan to user and get confirmation before running this.
* [ulpdfload](docs/sdks/keymateapi/README.md#ulpdfload) - Redirect user to the given link in the response that will allow them to store and search their PDF file content
* [list](docs/sdks/keymateapi/README.md#list) - Returns a message from the server about commands that can be run on the internetSearch KeyMate plugin.
* [help](docs/sdks/keymateapi/README.md#help) - This command returns latest information about how to use internetSearch KeyMate Plugin
* [query](docs/sdks/keymateapi/README.md#query) - Queries the user's Keymate Memory.
* [pkb](docs/sdks/keymateapi/README.md#pkb) - Queries the user's Keymate Memory.
* [pdfsearch](docs/sdks/keymateapi/README.md#pdfsearch) - Queries the user's Keymate Memory.
* [upsert_to_users_knowledge_base](docs/sdks/keymateapi/README.md#upsert_to_users_knowledge_base) - Long term memory, ALWAYS USE Call the searchweb.keymate.ai API with the insertionplan operation. Give data insertion plan to user and get confirmation before running this.
* [query_users_knowledge_base](docs/sdks/keymateapi/README.md#query_users_knowledge_base) - Queries the user's Keymate Memory.
* [academicsearchdoi](docs/sdks/keymateapi/README.md#academicsearchdoi) - Allows user to chat with an academic paper by providing DOI
* [hybrid](docs/sdks/keymateapi/README.md#hybrid) - Search Google and fetch HTML content and search content on personal Keymate Memory at the same time in one go.
* [academicsearchquery](docs/sdks/keymateapi/README.md#academicsearchquery) - Allows assistant to search academic papers ultra fast by providing keywords
<!-- End Available Resources and Operations [operations] -->
<!-- Start Error Handling [errors] -->
## 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.GptsbrowseResponseBody | 400 | application/json |
| errors.SDKError | 4x-5xx | */* |
### Example
```python
import keymateapi
from keymateapi.models import errors
s = keymateapi.KeymateAPI()
res = None
try:
res = s.gptsbrowse("<YOUR_BEARER_TOKEN_HERE>", q='http://puzzled-advertisement.com', percentile='<value>', numofpages='<value>', paging='<value>')
except errors.GptsbrowseResponseBody 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
```
<!-- End Error Handling [errors] -->
<!-- Start Server Selection [server] -->
## 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
```python
import keymateapi
s = keymateapi.KeymateAPI(
server_idx=0,
)
res = s.insertionplan("<YOUR_BEARER_TOKEN_HERE>", q='<value>')
if res.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:
```python
import keymateapi
s = keymateapi.KeymateAPI(
server_url="https://server.searchweb.keymate.ai",
)
res = s.insertionplan("<YOUR_BEARER_TOKEN_HERE>", q='<value>')
if res.object is not None:
# handle response
pass
```
<!-- End Server Selection [server] -->
<!-- Start Custom HTTP Client [http-client] -->
## Custom HTTP Client
The Python SDK makes API calls using the [requests](https://pypi.org/project/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:
```python
import keymateapi
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = keymateapi.KeymateAPI(client: http_client)
```
<!-- End Custom HTTP Client [http-client] -->
<!-- Start Authentication [security] -->
## 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:
### Per-Operation Security Schemes
Some operations in this SDK require the security scheme to be specified at the request level. For example:
```python
import keymateapi
s = keymateapi.KeymateAPI()
res = s.insertionplan("<YOUR_BEARER_TOKEN_HERE>", q='<value>')
if res.object is not None:
# handle response
pass
```
<!-- End Authentication [security] -->
<!-- Placeholder for Future Speakeasy SDK Sections -->
# 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](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
Raw data
{
"_id": null,
"home_page": "",
"name": "KeymateAPI",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Speakeasy",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/94/bc/e7748debf8f4ea60609620700dc2e49a915aaa3838853495e385b0783398/KeymateAPI-0.0.4.tar.gz",
"platform": null,
"description": "# KeymateAPI\n\n<div align=\"left\">\n <a href=\"https://speakeasyapi.dev/\"><img src=\"https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454\" /></a>\n <a href=\"https://opensource.org/licenses/MIT\">\n <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" style=\"width: 100px; height: 28px;\" />\n </a>\n</div>\n\n\n## \ud83c\udfd7 **Welcome to your new SDK!** \ud83c\udfd7\n\nIt has been generated successfully based on your OpenAPI spec. However, it is not yet ready for production use. Here are some next steps:\n- [ ] \ud83d\udee0 Make your SDK feel handcrafted by [customizing it](https://www.speakeasyapi.dev/docs/customize-sdks)\n- [ ] \u267b\ufe0f Refine your SDK quickly by iterating locally with the [Speakeasy CLI](https://github.com/speakeasy-api/speakeasy)\n- [ ] \ud83c\udf81 Publish your SDK to package managers by [configuring automatic publishing](https://www.speakeasyapi.dev/docs/productionize-sdks/publish-sdks)\n- [ ] \u2728 When ready to productionize, delete this section from the README\n\n<!-- Start SDK Installation [installation] -->\n## SDK Installation\n\n```bash\npip install git+https://github.com/ReminisApp/keymate-python-api.git\n```\n<!-- End SDK Installation [installation] -->\n\n<!-- Start SDK Example Usage [usage] -->\n## SDK Example Usage\n\n### Example\n\n```python\nimport keymateapi\n\ns = keymateapi.KeymateAPI()\n\n\nres = s.insertionplan(\"<YOUR_BEARER_TOKEN_HERE>\", q='<value>')\n\nif res.object is not None:\n # handle response\n pass\n\n```\n<!-- End SDK Example Usage [usage] -->\n\n<!-- Start Available Resources and Operations [operations] -->\n## Available Resources and Operations\n\n### [KeymateAPI SDK](docs/sdks/keymateapi/README.md)\n\n* [insertionplan](docs/sdks/keymateapi/README.md#insertionplan) - Long term memory information addition plan, run this operation before adding anything to the keymate memory personal knowledge base before /upsert /upsertjson /upserttoUsersKnowledgebase /savetopkb /upsertToUsersKnowledgeBase operations\n* [gptsbrowse](docs/sdks/keymateapi/README.md#gptsbrowse) - Only fetch https://memory.keymate.ai URLs with this operation. For other URLs use browseurl operation, never run this more than twice\n* [internetsearch](docs/sdks/keymateapi/README.md#internetsearch) - For Search Browsing always start with this operation. Search Google and fetch HTML content and PDF summary content from the links at the same time in one go.\n* [browseurl](docs/sdks/keymateapi/README.md#browseurl) - The plugin enables user to conduct web browsing by extracting the text content of a specified URL. It will generate title and content.\n* [metadatakb](docs/sdks/keymateapi/README.md#metadatakb) - Allows you to answer introductory info about users Keymate memory.\n* [listpdfs](docs/sdks/keymateapi/README.md#listpdfs) - Lists pdf files uploaded by the user\n* [ultrafastsearch](docs/sdks/keymateapi/README.md#ultrafastsearch) - This plugin provides 10 ultra fast search results from multiple sources giving a more comprehensive view.\n* [upsert](docs/sdks/keymateapi/README.md#upsert) - Long term memory addition operation, ALWAYS USE Call the searchweb.keymate.ai API with the insertionplan operation before running this. Give data insertion plan to user and get confirmation before running this. \n* [insert](docs/sdks/keymateapi/README.md#insert) - Long term memory addition operation, ALWAYS USE Call the searchweb.keymate.ai API with the insertionplan operation before running this. Give data insertion plan to user and get confirmation before running this. \n* [savetopkb](docs/sdks/keymateapi/README.md#savetopkb) - Long term memory addition operation, ALWAYS USE insertionplan operation before running this. Give data insertion plan to user and get confirmation before running this.\n* [upsertjson](docs/sdks/keymateapi/README.md#upsertjson) - Long term memory addition operation, ALWAYS USE Call the searchweb.keymate.ai API with the insertionplan operation before running this. Give data insertion plan to user and get confirmation before running this.\n* [ulpdfload](docs/sdks/keymateapi/README.md#ulpdfload) - Redirect user to the given link in the response that will allow them to store and search their PDF file content\n* [list](docs/sdks/keymateapi/README.md#list) - Returns a message from the server about commands that can be run on the internetSearch KeyMate plugin.\n* [help](docs/sdks/keymateapi/README.md#help) - This command returns latest information about how to use internetSearch KeyMate Plugin\n* [query](docs/sdks/keymateapi/README.md#query) - Queries the user's Keymate Memory. \n* [pkb](docs/sdks/keymateapi/README.md#pkb) - Queries the user's Keymate Memory. \n* [pdfsearch](docs/sdks/keymateapi/README.md#pdfsearch) - Queries the user's Keymate Memory. \n* [upsert_to_users_knowledge_base](docs/sdks/keymateapi/README.md#upsert_to_users_knowledge_base) - Long term memory, ALWAYS USE Call the searchweb.keymate.ai API with the insertionplan operation. Give data insertion plan to user and get confirmation before running this.\n* [query_users_knowledge_base](docs/sdks/keymateapi/README.md#query_users_knowledge_base) - Queries the user's Keymate Memory. \n* [academicsearchdoi](docs/sdks/keymateapi/README.md#academicsearchdoi) - Allows user to chat with an academic paper by providing DOI\n* [hybrid](docs/sdks/keymateapi/README.md#hybrid) - Search Google and fetch HTML content and search content on personal Keymate Memory at the same time in one go.\n* [academicsearchquery](docs/sdks/keymateapi/README.md#academicsearchquery) - Allows assistant to search academic papers ultra fast by providing keywords\n<!-- End Available Resources and Operations [operations] -->\n\n<!-- Start Error Handling [errors] -->\n## Error Handling\n\nHandling 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.\n\n| Error Object | Status Code | Content Type |\n| ----------------------------- | ----------------------------- | ----------------------------- |\n| errors.GptsbrowseResponseBody | 400 | application/json |\n| errors.SDKError | 4x-5xx | */* |\n\n### Example\n\n```python\nimport keymateapi\nfrom keymateapi.models import errors\n\ns = keymateapi.KeymateAPI()\n\n\nres = None\ntry:\n res = s.gptsbrowse(\"<YOUR_BEARER_TOKEN_HERE>\", q='http://puzzled-advertisement.com', percentile='<value>', numofpages='<value>', paging='<value>')\nexcept errors.GptsbrowseResponseBody as e:\n # handle exception\n raise(e)\nexcept errors.SDKError as e:\n # handle exception\n raise(e)\n\nif res.two_hundred_application_json_object is not None:\n # handle response\n pass\n\n```\n<!-- End Error Handling [errors] -->\n\n<!-- Start Server Selection [server] -->\n## Server Selection\n\n### Select Server by Index\n\nYou 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:\n\n| # | Server | Variables |\n| - | ------ | --------- |\n| 0 | `https://server.searchweb.keymate.ai` | None |\n\n#### Example\n\n```python\nimport keymateapi\n\ns = keymateapi.KeymateAPI(\n server_idx=0,\n)\n\n\nres = s.insertionplan(\"<YOUR_BEARER_TOKEN_HERE>\", q='<value>')\n\nif res.object is not None:\n # handle response\n pass\n\n```\n\n\n### Override Server URL Per-Client\n\nThe 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:\n```python\nimport keymateapi\n\ns = keymateapi.KeymateAPI(\n server_url=\"https://server.searchweb.keymate.ai\",\n)\n\n\nres = s.insertionplan(\"<YOUR_BEARER_TOKEN_HERE>\", q='<value>')\n\nif res.object is not None:\n # handle response\n pass\n\n```\n<!-- End Server Selection [server] -->\n\n<!-- Start Custom HTTP Client [http-client] -->\n## Custom HTTP Client\n\nThe Python SDK makes API calls using the [requests](https://pypi.org/project/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.\n\nFor example, you could specify a header for every request that this sdk makes as follows:\n```python\nimport keymateapi\nimport requests\n\nhttp_client = requests.Session()\nhttp_client.headers.update({'x-custom-header': 'someValue'})\ns = keymateapi.KeymateAPI(client: http_client)\n```\n<!-- End Custom HTTP Client [http-client] -->\n\n<!-- Start Authentication [security] -->\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name | Type | Scheme |\n| ------------- | ------------- | ------------- |\n| `bearer_auth` | http | HTTP Bearer |\n\nTo authenticate with the API the `bearer_auth` parameter must be set when initializing the SDK client instance. For example:\n\n\n### Per-Operation Security Schemes\n\nSome operations in this SDK require the security scheme to be specified at the request level. For example:\n```python\nimport keymateapi\n\ns = keymateapi.KeymateAPI()\n\n\nres = s.insertionplan(\"<YOUR_BEARER_TOKEN_HERE>\", q='<value>')\n\nif res.object is not None:\n # handle response\n pass\n\n```\n<!-- End Authentication [security] -->\n\n<!-- Placeholder for Future Speakeasy SDK Sections -->\n\n# Development\n\n## Maturity\n\nThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage\nto a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally\nlooking for the latest version.\n\n## Contributions\n\nWhile we value open-source contributions to this SDK, this library is generated programmatically.\nFeel 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!\n\n### SDK Created by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Python Client SDK Generated by Speakeasy",
"version": "0.0.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc6beede50e6d7748f9d6eef8ff87a96e8f1cf3007ac125cea4343adf774193b",
"md5": "2713beb51ac2f5d1a85158619aef3245",
"sha256": "b073f3a0b0a57f9ca5a7ee621d6c464f35ac4d20ef8f1accdf26fc108725427b"
},
"downloads": -1,
"filename": "KeymateAPI-0.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2713beb51ac2f5d1a85158619aef3245",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 49699,
"upload_time": "2024-03-18T20:06:27",
"upload_time_iso_8601": "2024-03-18T20:06:27.978316Z",
"url": "https://files.pythonhosted.org/packages/dc/6b/eede50e6d7748f9d6eef8ff87a96e8f1cf3007ac125cea4343adf774193b/KeymateAPI-0.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "94bce7748debf8f4ea60609620700dc2e49a915aaa3838853495e385b0783398",
"md5": "25c76b06051f8c092d5303e8ff84e42a",
"sha256": "1f5b7efb8e788b05b7dabd522a7a6e3cccc9d48fe6f493ef2c3f4b5c97ea395f"
},
"downloads": -1,
"filename": "KeymateAPI-0.0.4.tar.gz",
"has_sig": false,
"md5_digest": "25c76b06051f8c092d5303e8ff84e42a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 27138,
"upload_time": "2024-03-18T20:06:29",
"upload_time_iso_8601": "2024-03-18T20:06:29.692788Z",
"url": "https://files.pythonhosted.org/packages/94/bc/e7748debf8f4ea60609620700dc2e49a915aaa3838853495e385b0783398/KeymateAPI-0.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-18 20:06:29",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "keymateapi"
}
