Interface TimeSeriesForecastParams

Parameters for the timeSeriesForecast operation.

interface TimeSeriesForecastParams {
    data: WatsonXAI.JsonObject;
    headers?: OutgoingHttpHeaders;
    modelId: string;
    parameters?: WatsonXAI.TSForecastParameters;
    projectId?: string;
    schema: WatsonXAI.TSForecastInputSchema;
    signal?: AbortSignal;
    spaceId?: string;
}

Hierarchy (view full)

Properties

data headers? modelId parameters? projectId? schema signal? spaceId?

Properties

data

data: WatsonXAI.JsonObject

A payload of data matching schema. We assume the following about your data:

  • All timeseries are of equal length and are uniform in nature (the time difference between two successive rows is constant). This implies that there are no missing rows of data;
  • The data meet the minimum model-dependent historical context length which can be 512 or more rows per timeseries;

Note that the example payloads shown are for illustration purposes only. An actual payload would necessary be much larger to meet minimum model-specific context lengths.

Optional headers

headers?: OutgoingHttpHeaders

modelId

modelId: string

The model to be used for generating a forecast.

Optional parameters

parameters?: WatsonXAI.TSForecastParameters

The parameters for the forecast request.

Optional projectId

projectId?: string

The project that contains the resource. Either space_id or project_id has to be given.

schema

schema: WatsonXAI.TSForecastInputSchema

Contains metadata about your timeseries data input.

Optional signal

signal?: AbortSignal

Optional spaceId

spaceId?: string

The space that contains the resource. Either space_id or project_id has to be given.

Settings

Member Visibility

Theme

On This Page

dataheadersmodelIdparametersprojectIdschemasignalspaceId