# sentience_sdk
API Gateway for Sentience Platform - Web Content Extraction and Element Coordinate Mapping

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.0.0
- Package version: 0.2.0
- Generator version: 7.18.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import sentience_sdk
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import sentience_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import sentience_sdk
from sentience_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.sentienceapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = sentience_sdk.Configuration(
    host = "https://api.sentienceapi.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (API Key): apiKeyAuth
configuration = sentience_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with sentience_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sentience_sdk.SentienceObservationApi(api_client)
    authorization = 'Bearer sk_live_51Mz...' # str | Sentience API Key. Format: 'Bearer <API_KEY>'
    sentience_observe_request = sentience_sdk.SentienceObserveRequest() # SentienceObserveRequest | 

    try:
        # Observe and extract web content or element coordinates
        api_response = api_instance.observe(authorization, sentience_observe_request)
        print("The response of SentienceObservationApi->observe:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SentienceObservationApi->observe: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.sentienceapi.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SentienceObservationApi* | [**observe**](docs/SentienceObservationApi.md#observe) | **POST** /v1/observe | Observe and extract web content or element coordinates


## Documentation For Models

 - [SentienceAppliedFilters](docs/SentienceAppliedFilters.md)
 - [SentienceBoundingBox](docs/SentienceBoundingBox.md)
 - [SentienceCreditDetails](docs/SentienceCreditDetails.md)
 - [SentienceElementFilter](docs/SentienceElementFilter.md)
 - [SentienceElementStates](docs/SentienceElementStates.md)
 - [SentienceErrorResponse](docs/SentienceErrorResponse.md)
 - [SentienceInsufficientCreditsError](docs/SentienceInsufficientCreditsError.md)
 - [SentienceInteractableElement](docs/SentienceInteractableElement.md)
 - [SentienceLayoutViewport](docs/SentienceLayoutViewport.md)
 - [SentienceMapModeResponse](docs/SentienceMapModeResponse.md)
 - [SentienceObserve200Response](docs/SentienceObserve200Response.md)
 - [SentienceObserveOptions](docs/SentienceObserveOptions.md)
 - [SentienceObserveRequest](docs/SentienceObserveRequest.md)
 - [SentienceOutputFormat](docs/SentienceOutputFormat.md)
 - [SentiencePlanTier](docs/SentiencePlanTier.md)
 - [SentienceProcessingMode](docs/SentienceProcessingMode.md)
 - [SentienceProxyFailure](docs/SentienceProxyFailure.md)
 - [SentienceReaderModeResponse](docs/SentienceReaderModeResponse.md)
 - [SentienceReaderModeResponseData](docs/SentienceReaderModeResponseData.md)
 - [SentienceRenderQuality](docs/SentienceRenderQuality.md)
 - [SentienceResponseMetadata](docs/SentienceResponseMetadata.md)
 - [SentienceSubscriptionDetails](docs/SentienceSubscriptionDetails.md)
 - [SentienceSubscriptionInactiveError](docs/SentienceSubscriptionInactiveError.md)
 - [SentienceViewport](docs/SentienceViewport.md)
 - [SentienceVisualModeResponse](docs/SentienceVisualModeResponse.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="apiKeyAuth"></a>
### apiKeyAuth

- **Type**: Bearer authentication (API Key)


## Author

support@sentienceapi.com


