Skip to content

Latest commit

 

History

History
389 lines (347 loc) · 27.2 KB

README.md

File metadata and controls

389 lines (347 loc) · 27.2 KB
Raw

wordlift-client

GraphQL endpoint to query Knowledge Graphs

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0
  • Package version: 1.71.0
  • Generator version: 7.6.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://wordlift.io

Requirements.

Python 3.7+

Installation & Usage

pip install

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

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:

import wordlift_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import wordlift_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import wordlift_client
from wordlift_client.rest import ApiException
from pprint import pprint

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

# 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: ApiKey
configuration.api_key['ApiKey'] = os.environ["API_KEY"]

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


# Enter a context with an instance of the API client
async with wordlift_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = wordlift_client.AccountApi(api_client)

    try:
        # Get
        api_response = await api_instance.get_me()
        print("The response of AccountApi->get_me:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->get_me: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.wordlift.io

Class Method HTTP request Description
AccountApi get_me GET /accounts/me Get
AccountStatsApi get_my_stats GET /accounts/me/stats Get my Account statistics
AccountsApi get_account GET /accounts/{id} Get an account.
AccountsApi list_accounts GET /accounts List
AccountsApi update_account PUT /accounts/{id} Update an account.
AddOnsApi list_configurations GET /addon/configurations List
AnalysesApi analyse POST /single Analyse content
AnalysesApi create POST /analysis/analyses Create
AnalysesApi merge POST /merge Analyse and Merge
AnalysesApi v2_analysis POST /v2/analyze Analyse Web Page
AnalyticsImportsApi create_analytics_import POST /analytics-imports Create
AuthorsApi create_author POST /data/authors Create
AutocompleteApi get1 GET /autocomplete Get
BotifyCrawlImportsApi create_botify_crawl_import POST /botify-crawl-imports Create
ClassificationsApi classify_using_post POST /classification/classify Create
ContentExpansionsApi create_content_expansion POST /content-expansions Create
ContentGenerationCompletionApi create_completion POST /completions Create a completion
ContentGenerationFieldsApi list_fields GET /content-generations/{contentGenerationId}/fields List
ContentGenerationFieldsApi list_fields_for_graph_ql_query POST /fields List for GraphQl Query
ContentGenerationModelsApi list_models GET /models List
ContentGenerationPresetsApi list_presets GET /graphql-query-presets List
ContentGenerationRecordsApi get_record GET /content-generations/{contentGenerationId}/records/{recordId} Get
ContentGenerationRecordsApi list_records GET /content-generations/{contentGenerationId}/records List
ContentGenerationRecordsApi list_records_as_events GET /content-generations/{contentGenerationId}/records-sse List as Events
ContentGenerationRecordsApi update_record PUT /content-generations/{contentGenerationId}/records/{recordId} Update
ContentGenerationRecordsApi update_records PUT /content-generations/{contentGenerationId}/records Update
ContentGenerationRecordsApi update_records_collection PUT /content-generations/{contentGenerationId}/records-collection Update
ContentGenerationRecordsExportApi export GET /content-generations/{contentGenerationId}/records.tsv
ContentGenerationRendersApi render_template POST /content-generations/renders Render
ContentGenerationRendersApi render_template_collection POST /content-generations/renders-collection Render
ContentGenerationStatsApi get4 GET /content-generations/{contentGenerationId}/stats Get
ContentGenerationSyncsApi create_sync1 POST /content-generations/{contentGenerationId}/syncs Create
ContentGenerationWordBiasesApi create_word POST /content-generations/{contentGenerationId}/words Create
ContentGenerationWordBiasesApi create_words PUT /content-generations/{contentGenerationId}/words Update for prompt
ContentGenerationWordBiasesApi create_words_from_csv PUT /content-generations/{contentGenerationId}/words/imports Update from CSV
ContentGenerationWordBiasesApi delete_word DELETE /content-generations/{contentGenerationId}/words/{id} Delete
ContentGenerationWordBiasesApi list_words GET /content-generations/{contentGenerationId}/words List
ContentGenerationWordBiasesApi update_word PUT /content-generations/{contentGenerationId}/words/{id} Update
ContentGenerationsApi create_content_generation POST /content-generations Create
ContentGenerationsApi delete_content_generation DELETE /content-generations/{id} Delete
ContentGenerationsApi duplicate_content_generation POST /content-generations/{from_content_generation_id}/duplicates Duplicate
ContentGenerationsApi get_content_generation GET /content-generations/{id} Get
ContentGenerationsApi list_content_generations GET /content-generations List
ContentGenerationsApi update_content_generation PUT /content-generations/{id} Update
CustomDomainsApi validate POST /validations Validate
DataURIApi get3 GET /data-uri Get the Web Data URI for a Web Page URL.
DatasetApi create_or_update_entities1 POST /dataset/batch Create or update many
DatasetApi create_or_update_entity POST /dataset Create or update one
DatasetApi delete_all_entities DELETE /dataset/all Delete all
DatasetApi delete_entity DELETE /dataset Delete one
EmbeddingApi create_embedding POST /kg/embeddings Create
EmbeddingsApi create_embeddings POST /api/embeddings Create Embeddings
EntitiesApi create_entities POST /entities Create
EntitiesApi create_or_update_entities PUT /entities Update (or create)
EntitiesApi delete_entities DELETE /entities Delete
EntitiesApi get_entities GET /entities Get
EntitiesApi patch_entities PATCH /entities Patch Entity
EntityGapsApi create_entity_gap POST /entity-gaps Create
FactCheckApi submit_fact_check POST /fact-check/score Submit a fact-checking request
GoogleMerchantsApi list_google_merchants GET /ext/google/shopping/merchants List
GoogleSearchConsoleApi list_website_search GET /ext/google/searchconsole/searches List Website Search data
GoogleSearchConsoleApi list_websites GET /ext/google/searchconsole/websites List
GoogleSearchConsoleOAuth2Api create_auth_code_exchange POST /google-search-console/oauth2/auth-code-exchanges Get an Access Code
GoogleSearchConsoleOAuth2Api create_authorize_uri POST /google-search-console/oauth2/authorize-uris Create an Authorization URI
GoogleSearchConsoleOAuth2Api duplicate POST /google-search-console/authorize/duplicate Duplicate the Google Search Console connection through accounts
GoogleSearchConsoleOAuth2Api login GET /google-search-console/authorize/init Login to the Google Search Console API client
GoogleSearchConsoleSearchesApi list_website_search1 GET /accounts/me/google/searches List Website Search data
GraphQLApi graphql_using_post POST /graphql Query
IncludeExcludesApi list_include_excludes GET /accounts/me/include-excludes List
IncludeExcludesApi update_include_excludes PUT /accounts/me/include-excludes Update
InspectorApi get2 GET /inspect Inspect
InternalLinksApi create_internal_link POST /internal-links Create
InternalLinksApi create_internal_link_suggestion POST /internal-links/suggestions Suggest
LongTailsApi get2 GET /longtail Get entities
LongTailsApi get3 GET /longtail/hook Get entities by rank (async)
LongTailsApi get_v2 GET /longtail/v2 Get entities by rank
MerchantSyncsApi create_sync POST /merchants/{merchantId}/syncs Start
MerchantSyncsApi get_merchant_sync GET /merchants/{merchantId}/syncs/{id} Get by id
MerchantSyncsApi list_merchant_syncs GET /merchants/{merchantId}/syncs List
MerchantsApi create_merchant POST /merchants Create
MerchantsApi delete_merchant DELETE /merchants/{id} Delete by id
MerchantsApi get_merchant GET /merchants/{id} Get by id
MerchantsApi list_merchants GET /merchants List
MerchantsApi update_merchant PUT /merchants/{id} Update
MicrodataApi microdata_to_json_ld GET /microdata-to-jsonld Microdata to JSON-LD
OAuth2AuthorizedClientsApi create_o_auth2_authorized_client POST /oauth2/authorized-clients Create
OAuth2AuthorizedClientsApi delete_o_auth2_authorized_client DELETE /oauth2/authorized-clients/{id} Delete
OAuth2AuthorizedClientsApi get_o_auth2_authorized_client GET /oauth2/authorized-clients/{id} Get
OAuth2AuthorizedClientsApi list_o_auth2_authorized_clients GET /oauth2/authorized-clients List
OAuth2AuthorizedClientsApi update_o_auth2_authorized_client PUT /oauth2/authorized-clients/{id} Update
PlatformConsumptionsApi create_or_update_my_platform_consumption PUT /platform-limit/consumptions/me Create or update the Platform Consumption
PlatformConsumptionsApi get_my_platform_consumption GET /platform-limit/consumptions/me Get the Platform Consumption
PlatformLimitsApi create_platform_limit POST /platform-limit/limits Create Platform Limit
PlatformLimitsApi delete_platform_limit DELETE /platform-limit/limits/{id} Delete Platform Limit
PlatformLimitsApi get_platform_limit GET /platform-limit/limits/{id} Get Platform Limit
PlatformLimitsApi list_platform_limits GET /platform-limit/limits List Platform Limits
PlatformLimitsApi update_platform_limit PUT /platform-limit/limits/{id} Update Platform Limit
PluginDiagnosticsApi update_diagnostic_plugin_collection PUT /accounts/me/plugin/diagnostics/plugins-collection Update
PluginEventsApi create_event POST /plugin/events Create
PluginEventsApi list_events GET /plugin/events List
QuestionsAndAnswersApi create_question_and_answer POST /questions-and-answers Create
QuestionsAndAnswersApi create_questions_and_answers_collection POST /questions-and-answers-collection Create
QuestionsAndAnswersApi delete_question_and_answer DELETE /questions-and-answers/{id} Delete
QuestionsAndAnswersApi delete_questions_and_answers_collection DELETE /questions-and-answers-collection Delete
QuestionsAndAnswersApi get_questions_and_answers GET /questions-and-answers Get
QuestionsAndAnswersApi update_question_and_answer PUT /questions-and-answers/{id} Update
QuestionsAndAnswersApi update_questions_and_answers_collection PUT /questions-and-answers-collection Update
RedeemCodesApi redeem_code POST /redeem-codes Redeem the provided code and get a key
RulesApi copy_rules POST /rules/copies Copy
RulesApi create_rule POST /rules Create
RulesApi delete_rule DELETE /rules/{id} Delete
RulesApi list_rules GET /rules List
RulesApi update_rule PUT /rules/{id} Update
RulesApi update_rule_collection PUT /rules-collection Update
SEOScoresApi create_seo_score POST /score Create
SitemapGeneratorApi generate_sitemap POST /build Generate Sitemap
SitemapImportsApi create_sitemap_import POST /sitemap-imports Create
SummarizationsApi microdata_to_json_ld_using_post POST /summarize Create
VectorSearchNodesApi update_nodes_collection PUT /vector-search/nodes-collection Update
VectorSearchQueriesApi create_query POST /vector-search/queries Create
VectorSearchQuestionsApi create_vector_search_question POST /vector-search/questions-collection Create
WebAsyncsMetadataApi get GET /webasyncs/{id} Get by id
WebAsyncsMetadataApi list GET /webasyncs List
WebAsyncsResponsesApi get1 GET /webasyncs/{id}/pull Get by id

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

[email protected]