Summarize Text

Generates a summarized version of the provided content.

This API is perfect for developers working on content management systems, marketing tools, or news aggregation platforms. It automates content summarization, making it easier to generate brief and impactful summaries. Use cases include creating marketing summaries, enhancing news digest features, and improving content readability for users. Ideal for creating concise marketing introductions from longer texts.

Only the content parameter is required.

You can limit the output with the max_length parameter. Please keep in mind that max_length serves as a strong suggestion for the Language Model, rather than a strict requirement, to maintain the general sense of the outcome.

You can set your preferred writing style by providing a voice_tone parameter. It can be adjectives like funny or joyous, or even the name of a famous writer.

An optional context parameter is also available. It can be used to add additional processing instructions for the content.

AI jobs involve two key steps::

  1. Submitting the AI job: Initiating the process by sending the job request.
  2. Monitoring and receiving results: Continuously checking the job status and obtaining the final output upon successful completion.

Step 1. Submit the AI Job request

Endpoint: POST - /api/v1/content/summarize

Attribute Type Mandatory Description
content String Yes Provide the content to summarize.
voice_tone String No Specify the voice tone of the output. It can be adjectives like funny or joyous, or even the name of a famous writer.
max_length Number No Specify the maximum length of the summary in words. Eg. 100.
language String No Specify the language of the output, defaults to English.
context String No Additional processing instructions for the content.

REQUEST EXAMPLE:

{
  "content": "Red Bull's Max Verstappen says this weekend's Las Vegas Grand Prix is \"99% show and 1% sporting event\". \n\n The triple world champion said he is \"not looking forward\" to the razzmatazz around the race, the first time Formula 1 cars have raced down the city's famous Strip. \n\n Other leading drivers were more equivocal about the hype.\n\n Aston Martin's Fernando Alonso said: \"With the investment that has been made and the place we are racing, it deserves a little bit [of] different treatment and extra show.\" \n\n The weekend was kick-started on Wednesday evening with a lavish opening ceremony.\n\n It featured performances from several music stars, including Kylie Minogue and Journey, and culminated in the drivers being introduced to a sparsely populated crowd in light rain by being lifted into view on hydraulic platforms under a sound-and-light show. \n\n Lewis Hamilton said: \"It's amazing to be here. It is exciting - such an incredible place, so many lights, a great energy, a great buzz. \n\n \"This is one of the most iconic cities there is. It is a big show, for sure. It is never going to be like Silverstone [in terms of history and purity]. But maybe over time the people in the community here will grow to love the sport.\" \n\n Hamilton added: \"It is a business, ultimately. You'll still see good racing here. \n\n \"Maybe the track will be good, maybe it will be bad. It was so-so on the [simulator]. Don't knock it 'til you try it. I hear there are a lot of people complaining about the direction [F1 president] Stefano [Domenicali] and [owners] Liberty have been going [but] I think they have been doing an amazing job.\"",
  "voice_tone": "Funny, Adventurous",
  "max_length": "250",
  "language": "English",
  "context": null
}

Monitor & Fetch AI Job Results

Endpoint: GET - /api/v1/content/summarize/job/status/:uuid

An endpoint is used to check on the progress of the requested API job.

RESULT EXAMPLE:

{
  "data": {
    "type": "api_job_result",
    "id": "5fa45f0e-6680-4f64-8528-3f085a87bd2f",
    "attributes": {
      "status": "success",
      "type": "content_summarize",
      "result": {
        "summary": "Max Verstappen thinks the Las Vegas Grand Prix is more showbiz than sport, while Lewis Hamilton and Fernando Alonso are soaking up the glitz. Expect hydraulic platforms, light shows, and maybe some racing. Don't knock it 'til you try it!"
      }
    }
  }
}
When Laravel/PHP E-commerce App Meets AI

When Laravel/PHP E-commerce App Meets AI

Jan 1, 2024

Hey fellow Laravel enthusiasts! In the ever-evolving landscape of e-commerce, integrating AI into your Laravel applications is not just a luxury, it’s a necessity. With SharpAPI’s Laravel package, it’s now easier than ever. In this blog, I’ll guide you through 10 transformative use cases for enhancing your Laravel-based e-commerce applications using SharpAPI.