Skip to content

SuggestionsApi.md

Latest commit

 

History

History
357 lines (249 loc) · 12.4 KB

SuggestionsApi.md

File metadata and controls

357 lines (249 loc) · 12.4 KB

rankvectors.SuggestionsApi

All URIs are relative to https://api.rankvectors.com

Method HTTP request Description
delete_suggestion DELETE /api/projects/{projectId}/suggestions/{suggestionId} Delete suggestion
generate_suggestions POST /api/projects/{projectId}/suggestions Generate link suggestions
get_suggestions GET /api/projects/{projectId}/suggestions Get link suggestions
update_suggestion PATCH /api/projects/{projectId}/suggestions/{suggestionId} Update suggestion status

delete_suggestion

DeleteSuggestion200Response delete_suggestion(project_id, suggestion_id)

Delete suggestion

Delete a link suggestion

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.delete_suggestion200_response import DeleteSuggestion200Response
from rankvectors.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.rankvectors.com
# See configuration.py for a list of all supported configuration parameters.
configuration = rankvectors.Configuration(
    host = "https://api.rankvectors.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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with rankvectors.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rankvectors.SuggestionsApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    suggestion_id = 'sugg-123' # str | Unique identifier for the suggestion

    try:
        # Delete suggestion
        api_response = api_instance.delete_suggestion(project_id, suggestion_id)
        print("The response of SuggestionsApi->delete_suggestion:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SuggestionsApi->delete_suggestion: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Unique identifier for the project
suggestion_id str Unique identifier for the suggestion

Return type

DeleteSuggestion200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Suggestion deleted successfully -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

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

generate_suggestions

GenerateSuggestions200Response generate_suggestions(project_id, generate_suggestions_request=generate_suggestions_request)

Generate link suggestions

Generate new AI-powered link suggestions for a project

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.generate_suggestions200_response import GenerateSuggestions200Response
from rankvectors.models.generate_suggestions_request import GenerateSuggestionsRequest
from rankvectors.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.rankvectors.com
# See configuration.py for a list of all supported configuration parameters.
configuration = rankvectors.Configuration(
    host = "https://api.rankvectors.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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with rankvectors.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rankvectors.SuggestionsApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    generate_suggestions_request = rankvectors.GenerateSuggestionsRequest() # GenerateSuggestionsRequest |  (optional)

    try:
        # Generate link suggestions
        api_response = api_instance.generate_suggestions(project_id, generate_suggestions_request=generate_suggestions_request)
        print("The response of SuggestionsApi->generate_suggestions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SuggestionsApi->generate_suggestions: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Unique identifier for the project
generate_suggestions_request GenerateSuggestionsRequest [optional]

Return type

GenerateSuggestions200Response

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Suggestions generated successfully -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

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

get_suggestions

List[Suggestion] get_suggestions(project_id, status=status)

Get link suggestions

Get AI-generated link suggestions for a project

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.suggestion import Suggestion
from rankvectors.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.rankvectors.com
# See configuration.py for a list of all supported configuration parameters.
configuration = rankvectors.Configuration(
    host = "https://api.rankvectors.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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with rankvectors.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rankvectors.SuggestionsApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    status = 'pending' # str | Filter suggestions by status (optional)

    try:
        # Get link suggestions
        api_response = api_instance.get_suggestions(project_id, status=status)
        print("The response of SuggestionsApi->get_suggestions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SuggestionsApi->get_suggestions: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Unique identifier for the project
status str Filter suggestions by status [optional]

Return type

List[Suggestion]

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 List of link suggestions -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

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

update_suggestion

Suggestion update_suggestion(project_id, suggestion_id, update_suggestion_request)

Update suggestion status

Update the status of a link suggestion

Example

  • Api Key Authentication (ApiKeyAuth):
import rankvectors
from rankvectors.models.suggestion import Suggestion
from rankvectors.models.update_suggestion_request import UpdateSuggestionRequest
from rankvectors.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.rankvectors.com
# See configuration.py for a list of all supported configuration parameters.
configuration = rankvectors.Configuration(
    host = "https://api.rankvectors.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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'

# Enter a context with an instance of the API client
with rankvectors.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = rankvectors.SuggestionsApi(api_client)
    project_id = 'proj-123' # str | Unique identifier for the project
    suggestion_id = 'sugg-123' # str | Unique identifier for the suggestion
    update_suggestion_request = rankvectors.UpdateSuggestionRequest() # UpdateSuggestionRequest | 

    try:
        # Update suggestion status
        api_response = api_instance.update_suggestion(project_id, suggestion_id, update_suggestion_request)
        print("The response of SuggestionsApi->update_suggestion:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling SuggestionsApi->update_suggestion: %s\n" % e)

Parameters

Name Type Description Notes
project_id str Unique identifier for the project
suggestion_id str Unique identifier for the suggestion
update_suggestion_request UpdateSuggestionRequest

Return type

Suggestion

Authorization

ApiKeyAuth

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Suggestion updated successfully -
400 Bad request - invalid parameters -
401 Unauthorized - missing or invalid API key -
403 Forbidden - access denied to resource -
404 Not found - resource doesn't exist -
500 Internal server error -

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