Class Summarization
- java.lang.Object
-
- ai.rev.speechtotext.models.asynchronous.Summarization
-
public class Summarization extends Object
A Summarization Job object provides all the information associated with a summarization job submitted by the user.
-
-
Constructor Summary
Constructors Constructor Description Summarization()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetCompletedOn()Returns a String that contains the date and time the job was completed on in ISO-8601 UTC form.StringgetFailure()Returns failure details.SummarizationJobStatusgetJobStatus()Returns theSummarizationJobStatusenumeration value.TranslationModelgetModel()Returns backend model used for the summarization job.StringgetPrompt()Returns custom prompt used for the summarization job.SummarizationFormattingOptionsgetType()Returns summary formatting options requested for the summarization job.
-
-
-
Method Detail
-
getJobStatus
public SummarizationJobStatus getJobStatus()
Returns theSummarizationJobStatusenumeration value.- Returns:
- The
SummarizationJobStatusenumeration value. - See Also:
SummarizationJobStatus
-
getPrompt
public String getPrompt()
Returns custom prompt used for the summarization job.- Returns:
- Custom prompt used for the summarization job.
-
getModel
public TranslationModel getModel()
Returns backend model used for the summarization job.- Returns:
- Backend model used for the summarization job.
- See Also:
TranslationModel
-
getType
public SummarizationFormattingOptions getType()
Returns summary formatting options requested for the summarization job.- Returns:
- Summary formatting options requested for the summarization job.
- See Also:
SummarizationFormattingOptions
-
getCompletedOn
public String getCompletedOn()
Returns a String that contains the date and time the job was completed on in ISO-8601 UTC form.- Returns:
- A String that contains the date and time the job was completed on in ISO-8601 UTC form.
-
getFailure
public String getFailure()
Returns failure details.- Returns:
- Failure details.
-
-