Skip to main content

getPredictSummary

The getPredictSummary function fetches the prediction summary for a consultation. This summary is generated based on the analysis of the consultation using a machine learning model and provides a brief overview or final result.

Parameters​

  • consultation_id: (number) - The ID of the consultation for which the prediction summary is being fetched.

Returns​

  • Promise<ResponseType<PredictSummary>>: A promise that resolves with a PredictSummary object containing the consultation’s prediction summary.

Fields​

  • summary: (string?) - A textual summary of the consultation's prediction result.

Example Usage​

const summary = await getPredictSummary(12345);
console.log(summary.data.summary);  // Output: "This is a summary based on the consultation analysis."