Package com.simplidh.api

Interface IGhostwritRIO

All Superinterfaces:
Serializable
public interface IGhostwritRIO extends Serializable
Author:
Phillip Austerfield

  • Method Details

    • getQuestions

      @NotNull List<String> getQuestions(@NotNull String sTopic, @NotNull String sTargetLanguage) throws IllegalStateException
      Generates questions to a given keyword or context
      Parameters:
      sTopic - Topic to generate questions for
      sTargetLanguage - Target Language
      Returns:
      List of questions
      Throws:
      IllegalStateException

    • createText

      @NotNull IGeneratedText createText(@NotNull String sQuestionOrTopic, @NotNull String sTargetLanguage) throws IllegalStateException
      Create a text based on the given question.Neither sources will be given nor white-/blacklists used.
      Parameters:
      sQuestionOrTopic - Question/Topic
      sTargetLanguage - Target Language
      Returns:
      Throws:
      IllegalStateException

    • createFaqs

      @NotNull List<IGeneratedFaq> createFaqs(@NotNull String sText, @NotNull String sTargetLanguage) throws IllegalStateException
      Create FAQs based on a text
      Parameters:
      sText - Input Text
      sTargetLanguage - Target Language
      Returns:
      List of Questions/Answers
      Throws:
      IllegalStateException

    • createText

      @NotNull IGeneratedText createText(@NotNull String sQuestionOrTopic, @NotNull String sTargetLanguage, boolean bIncludeSources, @Nullable String[] asListWhitelist, @Nullable String[] asListBlacklist) throws IllegalStateException
      Create a text based on the given question.Neither sources will be given nor white-/blacklists used.
      Parameters:
      sQuestionOrTopic -
      sTargetLanguage -
      bIncludeSources -
      asListWhitelist -
      asListBlacklist -
      Returns:
      Throws:
      IllegalStateException

    • extendText

      @NotNull ITransformR extendText()
      This service inserts text to existing text based on the given context. The text will be inserted somewhere in the existing text.
      Returns:

    • spinText

      @NotNull ITransformR spinText(int nVersion)
      Rephrase a given text
      Parameters:
      nVersion - Version 1-3
      Returns:

    • generateTitle

      @NotNull ITransformR generateTitle()
      Generate a title from a given text
      Returns:

    • changeFormality

      @NotNull ITransformR changeFormality()
      Change the formality of a given text
      Returns:

    • continueText

      @NotNull ITransformR continueText()
      Continue given text
      Returns:

    • createShortSummary

      @NotNull ITransformR createShortSummary()
      Create a short summary of a given text
      Returns:

    • generateTweet

      @NotNull ITransformR generateTweet()
      Create tweet from a given text
      Returns:

    • generateLinkedIn

      @NotNull ITransformR generateLinkedIn()
      Create Linkedin post from a given text
      Returns:

    • generateMetadescription

      @NotNull ITransformR generateMetadescription(boolean bAddAlternatives)
      Create meta description from a given text.
      Parameters:
      bAddAlternatives - Add alternative descriptions to the result list that will be created - if available, these will be added to the result list. The first list entry will always be the preferred meta description.
      Returns:

    • generateKeywords

      @NotNull ITransformR generateKeywords()
      Create Keywords from a given text
      Returns:

    • generateTextFromProductData

      @NotNull IProductR generateTextFromProductData()
      Create texts from structured product data and descriptions, which can be used as marketing texts or descriptive texts on a website or in other materials.
      Returns:

    • generateImageCaption

      @NotNull ICaptionR generateImageCaption()
      Create captions
      Returns:

    • getStatusInformation

      @NotNull IClientStatus getStatusInformation()
      Get client status information
      Returns:

    • optimize

      @NotNull IOptimize optimize()
      Get optimize operations
      Returns: