RecommendationEngineApi.md

RecommendationEngineApi

All URIs are relative to http://localhost

Method	Description
get_recommendation_unit_by_id	Get Recommendation Unit By Id
get_recommendation_units	Get Recommendation Units
get_recommendations	Get Recommendations

get_recommendation_unit_by_id

ResponseGetRecommendationUnitByIdResponse get_recommendation_unit_by_id(recommendation_id)

Get Recommendation Unit By Id

An API endpoint that retrieves recommendation unit by ID

Example

import onelens_backend_client
from onelens_backend_client.models.response_get_recommendation_unit_by_id_response import ResponseGetRecommendationUnitByIdResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = onelens_backend_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.RecommendationEngineApi(api_client)
    recommendation_id = 'recommendation_id_example' # str | 

    try:
        # Get Recommendation Unit By Id
        api_response = api_instance.get_recommendation_unit_by_id(recommendation_id)
        print("The response of RecommendationEngineApi->get_recommendation_unit_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RecommendationEngineApi->get_recommendation_unit_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
recommendation_id	str

Return type

ResponseGetRecommendationUnitByIdResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_recommendation_units

ResponseGetRecommendationUnitsResponse get_recommendation_units(get_recommendation_units_request)

Get Recommendation Units

An API endpoint that retrieves recommendation unit by ID

Example

import onelens_backend_client
from onelens_backend_client.models.get_recommendation_units_request import GetRecommendationUnitsRequest
from onelens_backend_client.models.response_get_recommendation_units_response import ResponseGetRecommendationUnitsResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = onelens_backend_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.RecommendationEngineApi(api_client)
    get_recommendation_units_request = onelens_backend_client.GetRecommendationUnitsRequest() # GetRecommendationUnitsRequest | 

    try:
        # Get Recommendation Units
        api_response = api_instance.get_recommendation_units(get_recommendation_units_request)
        print("The response of RecommendationEngineApi->get_recommendation_units:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RecommendationEngineApi->get_recommendation_units: %s\n" % e)

Parameters

Name	Type	Description	Notes
get_recommendation_units_request	GetRecommendationUnitsRequest

Return type

ResponseGetRecommendationUnitsResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_recommendations

ResponseRecommendationEngineResponse get_recommendations(recommendation_engine_api_request)

Get Recommendations

An API endpoint that retrieves all recommendations for voilations.

Example

import onelens_backend_client
from onelens_backend_client.models.recommendation_engine_api_request import RecommendationEngineAPIRequest
from onelens_backend_client.models.response_recommendation_engine_response import ResponseRecommendationEngineResponse
from onelens_backend_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = onelens_backend_client.Configuration(
    host = "http://localhost"
)


# Enter a context with an instance of the API client
with onelens_backend_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = onelens_backend_client.RecommendationEngineApi(api_client)
    recommendation_engine_api_request = onelens_backend_client.RecommendationEngineAPIRequest() # RecommendationEngineAPIRequest | 

    try:
        # Get Recommendations
        api_response = api_instance.get_recommendations(recommendation_engine_api_request)
        print("The response of RecommendationEngineApi->get_recommendations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RecommendationEngineApi->get_recommendations: %s\n" % e)

Parameters

Name	Type	Description	Notes
recommendation_engine_api_request	RecommendationEngineAPIRequest

Return type

ResponseRecommendationEngineResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]