Skip to content

Latest commit

 

History

History
352 lines (233 loc) · 11.2 KB

RecommendationEngineServiceApi.md

File metadata and controls

352 lines (233 loc) · 11.2 KB
Raw

RecommendationEngineServiceApi

All URIs are relative to http://localhost

Method Description
create_action_type Create Action Type
get_action_types Get Action Types
get_recommendations Get recommendations.
query_executor Query Executor
update_action_type Update Action Type

create_action_type

CreateActionTypeResponse create_action_type(create_action_type_request)

Create Action Type

Example

import onelens_backend_client
from onelens_backend_client.models.create_action_type_request import CreateActionTypeRequest
from onelens_backend_client.models.create_action_type_response import CreateActionTypeResponse
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.RecommendationEngineServiceApi(api_client)
    create_action_type_request = onelens_backend_client.CreateActionTypeRequest() # CreateActionTypeRequest | 

    try:
        # Create Action Type
        api_response = api_instance.create_action_type(create_action_type_request)
        print("The response of RecommendationEngineServiceApi->create_action_type:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RecommendationEngineServiceApi->create_action_type: %s\n" % e)

Parameters

Name Type Description Notes
create_action_type_request CreateActionTypeRequest

Return type

CreateActionTypeResponse

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_action_types

GetActionTypeResponse get_action_types(get_action_type_request)

Get Action Types

Example

import onelens_backend_client
from onelens_backend_client.models.get_action_type_request import GetActionTypeRequest
from onelens_backend_client.models.get_action_type_response import GetActionTypeResponse
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.RecommendationEngineServiceApi(api_client)
    get_action_type_request = onelens_backend_client.GetActionTypeRequest() # GetActionTypeRequest | 

    try:
        # Get Action Types
        api_response = api_instance.get_action_types(get_action_type_request)
        print("The response of RecommendationEngineServiceApi->get_action_types:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RecommendationEngineServiceApi->get_action_types: %s\n" % e)

Parameters

Name Type Description Notes
get_action_type_request GetActionTypeRequest

Return type

GetActionTypeResponse

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

RecommendationEngineResponse get_recommendations(recommendation_engine_request)

Get recommendations.

Example

import onelens_backend_client
from onelens_backend_client.models.recommendation_engine_request import RecommendationEngineRequest
from onelens_backend_client.models.recommendation_engine_response import RecommendationEngineResponse
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.RecommendationEngineServiceApi(api_client)
    recommendation_engine_request = onelens_backend_client.RecommendationEngineRequest() # RecommendationEngineRequest | 

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

Parameters

Name Type Description Notes
recommendation_engine_request RecommendationEngineRequest

Return type

RecommendationEngineResponse

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]

query_executor

object query_executor(query_executor_request)

Query Executor

Example

import onelens_backend_client
from onelens_backend_client.models.query_executor_request import QueryExecutorRequest
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.RecommendationEngineServiceApi(api_client)
    query_executor_request = onelens_backend_client.QueryExecutorRequest() # QueryExecutorRequest | 

    try:
        # Query Executor
        api_response = api_instance.query_executor(query_executor_request)
        print("The response of RecommendationEngineServiceApi->query_executor:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RecommendationEngineServiceApi->query_executor: %s\n" % e)

Parameters

Name Type Description Notes
query_executor_request QueryExecutorRequest

Return type

object

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]

update_action_type

UpdateActionTypeResponse update_action_type(update_action_type_request)

Update Action Type

Example

import onelens_backend_client
from onelens_backend_client.models.update_action_type_request import UpdateActionTypeRequest
from onelens_backend_client.models.update_action_type_response import UpdateActionTypeResponse
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.RecommendationEngineServiceApi(api_client)
    update_action_type_request = onelens_backend_client.UpdateActionTypeRequest() # UpdateActionTypeRequest | 

    try:
        # Update Action Type
        api_response = api_instance.update_action_type(update_action_type_request)
        print("The response of RecommendationEngineServiceApi->update_action_type:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling RecommendationEngineServiceApi->update_action_type: %s\n" % e)

Parameters

Name Type Description Notes
update_action_type_request UpdateActionTypeRequest

Return type

UpdateActionTypeResponse

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]