/** * (C) Copyright IBM Corp. 2024-2026. * * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except * in compliance with the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software distributed under the License * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express * or implied. See the License for the specific language governing permissions and limitations under * the License. */ /// import type { UserOptions } from 'ibm-cloud-sdk-core'; import type { Unzip } from 'zlib'; import type { Stream } from "./lib/common.mjs"; import { WatsonxBaseService } from "./base/index.mjs"; import * as Types from "./types/index.mjs"; import * as BaseTypes from "./base/types/index.mjs"; import type { AdditionalCreateRequestParams, CreateRequestParams } from "./types/request.mjs"; /** * SDK entrypoint for IBM watsonx.ai product. Provides access to IBM watsonx.ai services including * text generation, embeddings, deployments, and model management. * * @example * ```typescript * const service = new WatsonXAI({ * version: '2024-03-14', * serviceUrl: 'https://us-south.ml.cloud.ibm.com', * authenticator: new IamAuthenticator({ apikey: 'your-api-key' }) * }); * ```; * * @class WatsonXAI * @extends WatsonxBaseService */ declare class WatsonXAI extends WatsonxBaseService { /** @ignore */ static PARAMETERIZED_SERVICE_URL: string; /** @ignore */ private static defaultUrlVariables; /** * Constructs a service URL by formatting the parameterized service URL. * * The parameterized service URL is: 'https://{region}.ml.cloud.ibm.com' * * The default variable values are: * * - 'region': 'us-south' * * @param {Map | Null} [providedUrlVariables] Map from variable names to desired * values. If a variable is not provided in this map, the default variable value will be used * instead. * @returns {string} The formatted URL with all variable placeholders replaced by values. */ static constructServiceUrl(providedUrlVariables: Map | null): string; /** Factory method */ /** * Constructs an instance of WatsonXAI with passed in options and external configuration. * * Ensuring backwards compatibility from v1.7.1. You can now use: * * ```typescript * const service = new WatsonXAI(options); * ``` * * @category Constructor * @param {UserOptions} [options] - The parameters to send to the service. * @param {string} [options.serviceName] - The name of the service to configure * @param {Authenticator} [options.authenticator] - The Authenticator object used to authenticate * requests to the service * @param {string} [options.serviceUrl] - The base URL for the service * @returns {WatsonXAI} - An instance of the WatsonXAI service */ static newInstance(options: UserOptions & WatsonXAI.TokenAuthenticationOptions & WatsonXAI.Certificates): WatsonXAI; /** * Creates and executes an HTTP request to the watsonx.ai API. Handles HTTPS agent configuration, * encryption parameters, and callback hooks. * * @template T - The expected response type * @param {CreateRequestParams} parameters - Request parameters including URL, method, headers, * and body * @param {AdditionalCreateRequestParams} [additionalParameters] - Optional additional parameters * @param {object} [additionalParameters.crypto] - Encryption configuration for the request body * @param {object} [additionalParameters.callbacks] - Callback handlers for request/response * lifecycle * @returns {Promise} Promise resolving to the API response * @protected */ protected createRequest(parameters: CreateRequestParams, additionalParameters?: AdditionalCreateRequestParams): Promise; /** Deployments */ /** * Create a new watsonx.ai deployment. * * Create a new deployment, currently the only supported type is `online`. * * If this is a deployment for a prompt tune then the `asset` object must exist and the `id` must * be the `id` of the `model` that was created after the prompt training. * * If this is a deployment for a prompt template then the `prompt_template` object should exist * and the `id` must be the `id` of the prompt template to be deployed. * * @category Deployments * @param {Object} params - The parameters to send to the service. * @param {string} params.name - The name of the resource. * @param {OnlineDeployment} params.online - Indicates that this is an online deployment. An * object has to be specified but can be empty. The `serving_name` can be provided in the * `online.parameters`. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.description] - A description of the resource. * @param {string[]} [params.tags] - A list of tags for this resource. * @param {JsonObject} [params.custom] - User defined properties specified as key-value pairs. * @param {SimpleRel} [params.promptTemplate] - A reference to a resource. * @param {HardwareSpec} [params.hardwareSpec] - A hardware specification. * @param {HardwareRequest} [params.hardwareRequest] - The requested hardware for deployment. * @param {Rel} [params.asset] - A reference to a resource. * @param {string} [params.baseModelId] - The base model that is required for this deployment if * this is for a prompt template or a prompt tune for an IBM foundation model. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A promise that resolves to * the response with deployment's data */ createDeployment(params: WatsonXAI.CreateDeploymentParams): Promise>; /** * Retrieve the deployments. * * Retrieve the list of deployments for the specified space or project. * * @category Deployments * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.servingName] - Retrieves the deployment, if any, that contains this * `serving_name`. * @param {string} [params.tagValue] - Retrieves only the resources with the given tag value. * @param {string} [params.assetId] - Retrieves only the resources with the given asset_id, * asset_id would be the model id. * @param {string} [params.promptTemplateId] - Retrieves only the resources with the given * prompt_template_id. * @param {string} [params.name] - Retrieves only the resources with the given name. * @param {string} [params.type] - Retrieves the resources filtered with the given type. There are * the deployment types as well as an additional `prompt_template` if the deployment type * includes a prompt template. * * The supported deployment types are (see the description for `deployed_asset_type` in the * deployment entity): * * 1. `prompt_tune` - when a prompt tuned model is deployed. 2. `foundation_model` - when a prompt * template is used on a pre-deployed IBM provided model. 3. `custom_foundation_model` - * when a custom foundation model is deployed. * * These can be combined with the flag `prompt_template` like this: * * 1. `type=prompt_tune` - return all prompt tuned model deployments. 2. `type=prompt_tune and * prompt_template` - return all prompt tuned model deployments with a prompt template. 3. * `type=foundation_model` * * - Return all prompt template deployments. 4. `type=foundation_model and prompt_template` - return * all prompt template deployments - this is the same as the previous query * because a `foundation_model` can only exist with a prompt template. 5. * `type=prompt_template` - return all deployments with a prompt template. * * @param {string} [params.state] - Retrieves the resources filtered by state. Allowed values are * `initializing`, `updating`, `ready` and `failed`. * @param {boolean} [params.conflict] - Returns whether `serving_name` is available for use or * not. This query parameter cannot be combined with any other parameter except for * `serving_name`. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a collection of deployment resources */ listDeployments(params?: WatsonXAI.ListDeploymentsParams): Promise>; /** * Retrieve the deployment details. * * Retrieve the deployment details with the specified identifier. * * @category Deployments * @param {Object} params - The parameters to send to the service. * @param {string} params.deploymentId - The deployment id. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to * a deployment resource */ getDeployment(params: WatsonXAI.DeploymentsGetParams): Promise>; /** * Update the deployment metadata. * * Update the deployment metadata. The following parameters of deployment metadata are supported * for the patch operation. * * - `/name` * - `/description` * - `/tags` * - `/custom` * - `/online/parameters` * - `/asset` - `replace` only * - `/prompt_template` - `replace` only * - `/hardware_spec` * - `/hardware_request` * - `/base_model_id` - `replace` only (applicable only to prompt template deployments referring to * IBM base foundation models) * * The PATCH operation with path specified as `/online/parameters` can be used to update the * `serving_name`. * * @category Deployments * @param {Object} params - The parameters to send to the service. * @param {string} params.deploymentId - The deployment id. * @param {JsonPatchOperation[]} params.jsonPatch - The json patch. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to * a deployment resource */ updateDeployment(params: WatsonXAI.DeploymentsUpdateParams): Promise>; /** * Delete the deployment. * * Delete the deployment with the specified identifier. * * @category Deployments * @param {Object} params - The parameters to send to the service. * @param {string} params.deploymentId - The deployment id. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deleteDeployment(params: WatsonXAI.DeploymentsDeleteParams): Promise>; /** * Infer text. * * Infer the next tokens for a given deployed model with a set of parameters. If a `serving_name` * is used then it must match the `serving_name` that is returned in the `inference` section when * the deployment was created. * * ### Return options * * Note that there is currently a limitation in this operation when using `return_options`, for * input only `input_text` will be returned if requested, for output the `input_tokens` and * `generated_tokens` will not be returned. * * @category Deployments * @param {Object} params - The parameters to send to the service. * @param {string} params.idOrName - The `id_or_name` can be either the `deployment_id` that * identifies the deployment or a `serving_name` that allows a predefined URL to be used to post * a prediction. * * The `project` or `space` for the deployment must have a WML instance that will be used for * limits and billing (if a paid plan). * @param {string} [params.input] - The prompt to generate completions. Note: The method tokenizes * the input internally. It is recommended not to leave any trailing spaces. * * This field is ignored if there is a prompt template. * @param {DeploymentTextGenProperties} [params.parameters] * * - The template properties if this request refers to a prompt template. * * @param {Moderations} [params.moderations] - Properties that control the moderations, for usages * such as `Hate and profanity` (HAP) and `Personal identifiable information` (PII) filtering. * This list can be extended with new types of moderations. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {Object} callbacks - The parameters to send to the service. * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>} A Promise that resolves to a * text generation response */ deploymentGenerateText(params: WatsonXAI.DeploymentsTextGenerationParams, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; /** * Infer text event stream. * * Infer the next tokens for a given deployed model with a set of parameters. This operation will * return the output tokens as a stream of events. If a `serving_name` is used then it must match * the `serving_name` that is returned in the `inference` when the deployment was created. * * ### Return options * * Note that there is currently a limitation in this operation when using `return_options`, for * input only `input_text` will be returned if requested, for output the `input_tokens` and * `generated_tokens` will not be returned, also the `rank` and `top_tokens` will not be * returned. * * @category Deployments * @param {Object} params - The parameters to send to the service. * @param {string} params.idOrName - The `id_or_name` can be either the `deployment_id` that * identifies the deployment or a `serving_name` that allows a predefined URL to be used to post * a prediction. * * The `project` or `space` for the deployment must have a WML instance that will be used for * limits and billing (if a paid plan). * @param {string} [params.input] - The prompt to generate completions. Note: The method tokenizes * the input internally. It is recommended not to leave any trailing spaces. * * ### Response * * Stream> represents a source of * streaming data. If request performed successfully Stream> returns either stream line by line. * Output will stream as follow: * * - Id: 1 * - Event: message * - Data: {data} * - Empty line which separates the next Event Message * * Or stream of objects. Output will stream as follow: { id: 2, event: 'message', data: {data} } * Here is one of the possibilities to read streaming output: * * Const stream = await watsonxAIServiceenerateTextStream(parameters); for await (const line of * stream) { console.log(line); } * * This field is ignored if there is a prompt template. * @param {DeploymentTextGenProperties} [params.parameters] * * - The template properties if this request refers to a prompt template. * * @param {Moderations} [params.moderations] - Properties that control the moderations, for usages * such as `Hate and profanity` (HAP) and `Personal identifiable information` (PII) filtering. * This list can be extended with new types of moderations. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {boolean} [params.returnObject] - Flag that indicates return type. Set 'true' to return * objects. * @param {Object} callbacks - The parameters to send to the service. * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>>} - * Promise resolving to Stream object. Stream object is AsyncIterable based class. Stream object * contains an additional property holding an AbortController, read more below. * @returns {AbortController} - Abort controller. Allows user to abort when reading from stream * without transition to Readable */ deploymentGenerateTextStream(params: WatsonXAI.DeploymentsTextGenerationStreamParams & { returnObject?: false; }, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; deploymentGenerateTextStream(params: WatsonXAI.DeploymentsTextGenerationStreamParams & { returnObject: true; }, callbacks?: WatsonXAI.RequestCallbacks>): Promise>>; /** * Infer text chat. * * Infer the next chat message for a given deployment. The deployment must reference a prompt * template which has `input_mode` set to `chat`. The model to the chat request will be from the * deployment `base_model_id`. Parameters to the chat request will be from the prompt template * `model_parameters`. Related guides: * [Deployment](https://cloud.ibm.com/apidocs/watsonx-ai#create-deployment), [Prompt * template](https://cloud.ibm.com/apidocs/watsonx-ai#post-prompt), [Text * chat](https://cloud.ibm.com/apidocs/watsonx-ai#text-chat). * * If a `serving_name` is used then it must match the `serving_name` that is returned in the * `inference` section when the deployment was created. * * @category Deployments * @param {Object} params - The parameters to send to the service. * @param {string} params.idOrName - The `id_or_name` can be either the `deployment_id` that * identifies the deployment or a `serving_name` that allows a predefined URL to be used to post * a prediction. The deployment must reference a prompt template with `input_mode` `chat`. * * The WML instance that is associated with the deployment will be used for limits and billing (if * a paid plan). * @param {DeploymentTextChatMessages[]} params.messages * * - The messages for this chat session. You cannot specify `system` `role` in the messages. * Depending on the model, the `content` of `system` `role` may be from `system_prompt` of * the prompt template, and will be automatically inserted into `messages`. * * As an example, depending on the model, if `system_prompt` of a prompt template is "You are * Granite Chat, an AI language model developed by IBM. You are a cautious assistant. You * carefully follow instructions. You are helpful and harmless and you follow ethical guidelines * and promote positive behavior.", a message with `system` `role` having `content` the same as * `system_prompt` is inserted. * @param {string} [params.context] - If specified, `context` will be inserted into `messages`. * Depending on the model, `context` may be inserted into the `content` with `system` `role`; or * into the `content` of the last message of `user` `role`. * * In the example, `context` "Today is Wednesday" is inserted as such `content` of `user` becomes * "Today is Wednesday. Who are you and which day is tomorrow?". * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {WatsonXAI.RequestCallbacks>} callbacks * - The object containing callbacks for requests and response * * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>} A Promise that resolves to a * text chat response */ deploymentsTextChat(params: WatsonXAI.DeploymentsTextChatParams, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; /** * Infer text chat event stream. * * Infer the next chat message for a given deployment. This operation will return the output * tokens as a stream of events. The deployment must reference a prompt template which has * `input_mode` set to `chat`. The model to the chat request will be from the deployment * `base_model_id`. Parameters to the chat request will be from the prompt template * `model_parameters`. Related guides: * [Deployment](https://cloud.ibm.com/apidocs/watsonx-ai#create-deployment), [Prompt * template](https://cloud.ibm.com/apidocs/watsonx-ai#post-prompt), [Text * chat](https://cloud.ibm.com/apidocs/watsonx-ai#text-chat). * * If a `serving_name` is used then it must match the `serving_name` that is returned in the * `inference` section when the deployment was created. * * @category Deployments * @param {Object} params - The parameters to send to the service. * @param {string} params.idOrName - The `id_or_name` can be either the `deployment_id` that * identifies the deployment or a `serving_name` that allows a predefined URL to be used to post * a prediction. The deployment must reference a prompt template with `input_mode` `chat`. * * The WML instance that is associated with the deployment will be used for limits and billing (if * a paid plan). * @param {DeploymentTextChatMessages[]} params.messages * * - The messages for this chat session. You cannot specify `system` `role` in the messages. * Depending on the model, the `content` of `system` `role` may be from `system_prompt` of * the prompt template, and will be automatically inserted into `messages`. * * As an example, depending on the model, if `system_prompt` of a prompt template is "You are * Granite Chat, an AI language model developed by IBM. You are a cautious assistant. You * carefully follow instructions. You are helpful and harmless and you follow ethical guidelines * and promote positive behavior.", a message with `system` `role` having `content` the same as * `system_prompt` is inserted. * @param {string} [params.context] - If specified, `context` will be inserted into `messages`. * Depending on the model, `context` may be inserted into the `content` with `system` `role`; or * into the `content` of the last message of `user` `role`. * * In the example, `context` "Today is Wednesday" is inserted as such `content` of `user` becomes * "Today is Wednesday. Who are you and which day is tomorrow?". * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {WatsonXAI.RequestCallbacks>} callbacks * - The object containing callbacks for requests and response * * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>>} * Return * * - Promise resolving to Stream object. Stream object is AsyncIterable based class. Stream object * contains an additional property holding an AbortController, read more below. * * @returns {AbortController} Return.controller - Abort controller. Allows user to abort when * reading from stream without transition to Readable */ deploymentsTextChatStream(params: WatsonXAI.DeploymentsTextChatStreamParams & { returnObject?: false; }, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; deploymentsTextChatStream(params: WatsonXAI.DeploymentsTextChatStreamParams & { returnObject: true; }, callbacks?: WatsonXAI.RequestCallbacks>): Promise>>; /** * Time series forecast. * * Generate forecasts, or predictions for future time points, given historical time series data. * * @param {Object} params - The parameters to send to the service. * @param {string} params.idOrName - The `id_or_name` can be either the `deployment_id` that * identifies the deployment or a `serving_name` that allows a predefined URL to be used to post * a prediction. * * The WML instance that is associated with the deployment will be used for limits and billing (if * a paid plan). * @param {JsonObject} params.data - 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 any number of 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. * @param {TSForecastInputSchema} params.schema - Contains metadata about your timeseries data * input. * @param {DeploymentTSForecastParameters} [params.parameters] * * - The parameters for the forecast request. * * @param {JsonObject} [params.futureData] - Exogenous or supporting features that extend into the * forecasting horizon (e.g., a weather forecast or calendar of special promotions) which are * known in advance. `future_data` would be in the same format as `data` except that all * timestamps would be in the forecast horizon and it would not include previously specified * `target_columns`. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to * a time series forecast response */ deploymentsTimeSeriesForecast(params: WatsonXAI.DeploymentsTimeSeriesForecastParams): Promise>; /** FoundationModelSpecs */ /** * List the available foundation models. * * Retrieve the list of deployed foundation models. * * @category Foundation Model Specs * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.start] - Token required for token-based pagination. This token cannot * be determined by end user. It is generated by the service and it is set in the href available * in the `next` field. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {string} [params.filters] - A set of filters to specify the list of models, filters are * described as the `pattern` shown below. * * ```text * pattern: tfilter[,tfilter][:(or|and)] * tfilter: filter | !filter * filter: Requires existence of the filter. * !filter: Requires absence of the filter. * filter: one of * modelid_*: Filters by model id. * Namely, select a model with a specific model id. * provider_*: Filters by provider. * Namely, select all models with a specific provider. * source_*: Filters by source. * Namely, select all models with a specific source. * input_tier_*: Filters by input tier. * Namely, select all models with a specific input tier. * output_tier_*: Filters by output tier. * Namely, select all models with a specific output tier. * tier_*: Filters by tier. * Namely, select all models with a specific input or output tier. * task_*: Filters by task id. * Namely, select all models that support a specific task id. * lifecycle_*: Filters by lifecycle state. * Namely, select all models that are currently in the specified lifecycle state. * function_*: Filters by function. * Namely, select all models that support a specific function. * ```. * ``` * * @param {boolean} [params.techPreview] - See all the `Tech Preview` models if entitled. @param * {OutgoingHttpHeaders} [params.headers] - Custom request headers @returns * {Promise>} A Promise that resolves to a list * of foundation models */ listFoundationModelSpecs(params?: WatsonXAI.ListFoundationModelSpecsParams): Promise>; /** * List the supported tasks. * * Retrieve the list of tasks that are supported by the foundation models. * * @category Foundation Model Specs * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.start] - Token required for token-based pagination. This token cannot * be determined by end user. It is generated by the service and it is set in the href available * in the `next` field. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves * to a list of foundation model tasks */ listFoundationModelTasks(params?: WatsonXAI.ListFoundationModelTasksParams): Promise>; /** Prompts */ /** * Create a new prompt / prompt template. * * This creates a new prompt with the provided parameters. * * @category Prompts / Prompt Templates * @param {Object} params - The parameters to send to the service. * @param {string} params.name - Name used to display the prompt. * @param {PromptWithExternal} params.prompt - * @param {string} [params.description] - An optional description for the prompt. * @param {number} [params.createdAt] - Time the prompt was created. * @param {string[]} [params.taskIds] - * @param {PromptLock} [params.lock] - * @param {WxPromptPostModelVersion} [params.modelVersion] - * @param {JsonObject} [params.promptVariables] - * @param {string} [params.inputMode] - Input mode in use for the prompt. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {string} [params.spaceId] - [REQUIRED] Specifies the space ID as the target. One target * must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt response */ createPrompt(params: WatsonXAI.PostPromptParams): Promise>; /** * Get a prompt. * * This retrieves a prompt / prompt template with the given id. * * @category Prompts / Prompt Templates * @param {Object} params - The parameters to send to the service. * @param {string} params.promptId - Prompt ID. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {string} [params.spaceId] - [REQUIRED] Specifies the space ID as the target. One target * must be supplied per request. * @param {string} [params.restrictModelParameters] - Only return a set of model parameters * compatiable with inferencing. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt response */ getPrompt(params: WatsonXAI.GetPromptParams): Promise>; /** * List all prompts. * * This retrieves all prompts within the given project/space. * * @category Prompts / Prompt Templates * @param {Object} params - The parameters to send to the service. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {string} [params.spaceId] - [REQUIRED] Specifies the space ID as the target. One target * must be supplied per request. * @param {string} [params.limit] - The limit request body field can be specified to limit the * number of assets in the search results. The default limit is 200. The maximum limit value is * 200, and any greater value is ignored. * @param {string} [params.counts] - Returns the number of query results for each unique value of * each named field. * @param {string} [params.drilldown] - Restrict results to documents with a dimension equal to * the specified label. Note that, multiple values for a single key in a drilldown means an OR * relation between them and there is an AND relation between multiple keys. * @param {string} [params.bookmark] - Bookmark of the query result * @param {string} [params.sort] - Sort order for the query * @param {string} [params.include] - Entity * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves * to a list of prompts */ listPrompts(params: WatsonXAI.PromptListParams): Promise>; /** * Update a prompt. * * This updates a prompt / prompt template with the given id. * * @category Prompts / Prompt Templates * @param {Object} params - The parameters to send to the service. * @param {string} params.promptId - Prompt ID. * @param {string} params.name - Name used to display the prompt. * @param {Prompt} params.prompt - * @param {string} [params.id] - The prompt's id. This value cannot be set. It is returned in * responses only. * @param {string} [params.description] - An optional description for the prompt. * @param {string[]} [params.taskIds] - * @param {boolean} [params.governanceTracked] - * @param {WxPromptPatchModelVersion} [params.modelVersion] - * @param {JsonObject} [params.promptVariables] - * @param {string} [params.inputMode] - Input mode in use for the prompt. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {string} [params.spaceId] - [REQUIRED] Specifies the space ID as the target. One target * must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt response */ updatePrompt(params: WatsonXAI.PatchPromptParams): Promise>; /** * Delete a prompt. * * This delets a prompt / prompt template with the given id. * * @category Prompts / Prompt Templates * @param {Object} params - The parameters to send to the service. * @param {string} params.promptId - Prompt ID. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {string} [params.spaceId] - [REQUIRED] Specifies the space ID as the target. One target * must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deletePrompt(params: WatsonXAI.DeletePromptParams): Promise>; /** * Prompt lock modifications. * * Modifies the current locked state of a prompt. * * @category Prompts / Prompt Templates * @param {Object} params - The parameters to send to the service. * @param {string} params.promptId - Prompt ID. * @param {boolean} params.locked - True if the prompt is currently locked. * @param {string} [params.lockType] - Lock type: 'edit' for working on prompts/templates or * 'governance'. Can only be supplied in PUT /lock requests. * @param {string} [params.lockedBy] - Locked by is computed by the server and shouldn't be * passed. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {string} [params.spaceId] - [REQUIRED] Specifies the space ID as the target. One target * must be supplied per request. * @param {boolean} [params.force] - Override a lock if it is currently taken. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt lock */ updatePromptLock(params: WatsonXAI.PutPromptLockParams): Promise>; /** * Get current prompt lock status. * * Retrieves the current locked state of a prompt. * * @category Prompts / Prompt Templates * @param {Object} params - The parameters to send to the service. * @param {string} params.promptId - Prompt ID. * @param {string} [params.spaceId] - [REQUIRED] Specifies the space ID as the target. One target * must be supplied per request. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt lock */ getPromptLock(params: WatsonXAI.GetPromptLockParams): Promise>; /** * Get the inference input string for a given prompt. * * Computes the inference input string based on state of a prompt. Optionally replaces template * params. * * @category Prompts / Prompt Templates * @param {Object} params - The parameters to send to the service. * @param {string} params.promptId - Prompt ID. * @param {string} [params.input] - Override input string that will be used to generate the * response. The string can contain template parameters. * @param {JsonObject} [params.promptVariables] - Supply only to replace placeholders. Object * content must be key:value pairs where the 'key' is the parameter to replace and 'value' is * the value to use. * @param {string} [params.spaceId] - [REQUIRED] Specifies the space ID as the target. One target * must be supplied per request. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to prompt input data */ getPromptInput(params: WatsonXAI.GetPromptInputParams): Promise>; /** * Add a new chat item to a prompt. * * This adds new chat items to the given prompt. * * @category Prompts / Prompt Templates * @param {Object} params - The parameters to send to the service. * @param {string} params.promptId - Prompt ID. * @param {ChatItem[]} params.chatItem - * @param {string} [params.spaceId] - [REQUIRED] Specifies the space ID as the target. One target * must be supplied per request. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ createPromptChatItem(params: WatsonXAI.PostPromptChatItemParams): Promise>; /** PromptSessions */ /** * Create a new prompt session. * * This creates a new prompt session. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.name - Name used to display the prompt session. * @param {string} [params.id] - The prompt session's id. This value cannot be set. It is returned * in responses only. * @param {string} [params.description] - An optional description for the prompt session. * @param {number} [params.createdAt] - Time the session was created. * @param {string} [params.createdBy] - The ID of the original session creator. * @param {number} [params.lastUpdatedAt] - Time the session was updated. * @param {string} [params.lastUpdatedBy] - The ID of the last user that modifed the session. * @param {PromptLock} [params.lock] - * @param {WxPromptSessionEntry[]} [params.prompts] - * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt response */ createPromptSession(params: WatsonXAI.PostPromptSessionParams): Promise>; /** * Get a prompt session. * * This retrieves a prompt session with the given id. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {boolean} [params.prefetch] - Include the most recent entry. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt session */ getPromptSession(params: WatsonXAI.GetPromptSessionParams): Promise>; /** * Update a prompt session. * * This updates a prompt session with the given id. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {string} [params.name] - * @param {string} [params.description] - An optional description for the prompt. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt session */ updatePromptSession(params: WatsonXAI.PatchPromptSessionParams): Promise>; /** * Delete a prompt session. * * This deletes a prompt session with the given id. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deletePromptSession(params: WatsonXAI.DeletePromptSessionParams): Promise>; /** * Add a new prompt to a prompt session. * * This creates a new prompt associated with the given session. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {string} params.name - Name used to display the prompt. * @param {number} params.createdAt - Time the prompt was created. * @param {Prompt} params.prompt - * @param {string} [params.id] - The prompt's id. This value cannot be set. It is returned in * responses only. * @param {string} [params.description] - An optional description for the prompt. * @param {JsonObject} [params.promptVariables] - * @param {boolean} [params.isTemplate] - * @param {string} [params.inputMode] - Input mode in use for the prompt. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves * to a prompt session entry */ createPromptSessionEntry(params: WatsonXAI.PostPromptSessionEntryParams): Promise>; /** * Get entries for a prompt session. * * List entries from a given session. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {string} [params.bookmark] - Bookmark from a previously limited get request. * @param {string} [params.limit] - Limit for results to retrieve, default 20. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a list of prompt session entries */ listPromptSessionEntries(params: WatsonXAI.GetPromptSessionEntriesParams): Promise>; /** * Add a new chat item to a prompt session entry. * * This adds new chat items to the given entry. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {string} params.entryId - Prompt Session Entry ID. * @param {ChatItem[]} params.chatItem - * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ createPromptSessionEntryChatItem(params: WatsonXAI.PostPromptSessionEntryChatItemParams): Promise>; /** * Prompt session lock modifications. * * Modifies the current locked state of a prompt session. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {boolean} params.locked - True if the prompt is currently locked. * @param {string} [params.lockType] - Lock type: 'edit' for working on prompts/templates or * 'governance'. Can only be supplied in PUT /lock requests. * @param {string} [params.lockedBy] - Locked by is computed by the server and shouldn't be * passed. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {boolean} [params.force] - Override a lock if it is currently taken. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt lock */ updatePromptSessionLock(params: WatsonXAI.PutPromptSessionLockParams): Promise>; /** * Get current prompt session lock status. * * Retrieves the current locked state of a prompt session. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt lock */ getPromptSessionLock(params: WatsonXAI.GetPromptSessionLockParams): Promise>; /** * Get a prompt session entry. * * This retrieves a prompt session entry with the given id. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {string} params.entryId - Prompt Session Entry ID. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * prompt response */ getPromptSessionEntry(params: WatsonXAI.GetPromptSessionEntryParams): Promise>; /** * Delete a prompt session entry. * * This deletes a prompt session entry with the given id. * * @category Prompt Sessions * @param {Object} params - The parameters to send to the service. * @param {string} params.sessionId - Prompt Session ID. * @param {string} params.entryId - Prompt Session Entry ID. * @param {string} [params.projectId] - [REQUIRED] Specifies the project ID as the target. One * target must be supplied per request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deletePromptSessionEntry(params: WatsonXAI.DeletePromptSessionEntryParams): Promise>; /** TextChat */ /** * Infer text. * * Infer the next tokens for a given deployed model with a set of parameters. * * @category Text Chat * @param {Object} params - The parameters to send to the service. * @param {string} params.modelId - The model to use for the chat completion. * * Please refer to the [list of * models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models.html?context=wx). * @param {TextChatMessages[]} params.messages - The messages for this chat session. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {TextChatParameterTools[]} [params.tools] - Tool functions that can be called with the * response. * @param {string} [params.toolChoiceOption] - Using `none` means the model will not call any tool * and instead generates a message. * * The following options (`auto` and `required`) are not yet supported * * Using `auto` means the model can pick between generating a message or calling one or more * tools. Using `required` means the model must call one or more tools. * * Only one of `tool_choice_option` or `tool_choice` must be present. * @param {TextChatToolChoiceTool} [params.toolChoice] - Specifying a particular tool via * `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that * tool. * * Only one of `tool_choice_option` or `tool_choice` must be present. * @param {number} [params.frequencyPenalty] - Positive values penalize new tokens based on their * existing frequency in the text so far, decreasing the model's likelihood to repeat the same * line verbatim. * @param {boolean} [params.logprobs] - Whether to return log probabilities of the output tokens * or not. If true, returns the log probabilities of each output token returned in the content * of message. * @param {number} [params.topLogprobs] - An integer specifying the number of most likely tokens * to return at each token position, each with an associated log probability. The option * `logprobs` must be set to `true` if this parameter is used. * @param {number} [params.maxTokens] - The maximum number of tokens that can be generated in the * chat completion. The total length of input tokens and generated tokens is limited by the * model's context length. * @param {number} [params.n] - How many chat completion choices to generate for each input * message. Note that you will be charged based on the number of generated tokens across all of * the choices. Keep n as 1 to minimize costs. * @param {number} [params.presencePenalty] - Positive values penalize new tokens based on whether * they appear in the text so far, increasing the model's likelihood to talk about new topics. * @param {TextChatResponseFormat} [params.responseFormat] * * - The chat response format parameters. * * @param {number} [params.temperature] - What sampling temperature to use,. Higher values like * 0.8 will make the output more random, while lower values like 0.2 will make it more focused * and deterministic. * * We generally recommend altering this or `top_p` but not both. * @param {number} [params.topP] - An alternative to sampling with temperature, called nucleus * sampling, where the model considers the results of the tokens with top_p probability mass. So * 0.1 means only the tokens comprising the top 10% probability mass are considered. * * We generally recommend altering this or `temperature` but not both. * @param {number} [params.timeLimit] - Time limit in milliseconds * * - If not completed within this time, generation will stop. The text generated so far will be * returned along with the `TIME_LIMIT`` stop reason. Depending on the users plan, and on * the model being used, there may be an enforced maximum time limit. * * @param {number} [params.repetitionPenalty] - Represents the penalty for penalizing tokens that * have already been generated or belong to the context. * @param {number} [params.lengthPenalty] - Exponential penalty to the length that is used with * beam-based generation. It is applied as an exponent to the sequence length, which in turn is * used to divide the score of the sequence. Since the score is the log likelihood of the * sequence (i.e. negative), `lengthPenalty` > 0.0 promotes longer sequences, while * `lengthPenalty` < 0.0 encourages shorter sequences. * @param {Crypto} [params.crypto] - Encryption configuration for securing inference requests. * Contains `key_ref` (identifier of the DEK in the keys management service IBM Key Protect CRN * format). * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {WatsonXAI.RequestCallbacks>} callbacks * - The object containing callbacks for requests and response * * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>} A Promise that resolves to a * text chat response */ textChat(params: WatsonXAI.TextChatParams, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; /** * Infer text event stream. * * Infer the next tokens for a given deployed model with a set of parameters. This operation will * return the output tokens as a stream of events * * ### Response * * Stream> represents a source of * streaming data. If request performed successfully Stream> returns either stream line by line. Output * will stream as follow: * * - Id: 1 * - Event: message * - Data: {data} * - Empty line which separates the next Event Message * * Or stream of objects. Output will stream as follow: { id: 2, event: 'message', data: {data} } * Here is one of the possibilities to read streaming output: * * Const stream = await watsonxAIServiceenerateTextStream(parameters); for await (const line of * stream) { console.log(line); }. * * @category Text Chat * @param {Object} params - The parameters to send to the service. * @param {string} params.modelId - The model to use for the chat completion. * * Please refer to the [list of * models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models.html?context=wx). * @param {TextChatMessages[]} params.messages - The messages for this chat session. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {TextChatParameterTools[]} [params.tools] - Tool functions that can be called with the * response. * @param {string} [params.toolChoiceOption] - Using `none` means the model will not call any tool * and instead generates a message. * * The following options (`auto` and `required`) are not yet supported. * * Using `auto` means the model can pick between generating a message or calling one or more * tools. Using `required` means the model must call one or more tools. * * Only one of `tool_choice_option` or `tool_choice` must be present. * @param {TextChatToolChoiceTool} [params.toolChoice] - Specifying a particular tool via * `{"type": "function", "function": {"name": "my_function"}}` forces the model to call that * tool. * * Only one of `tool_choice_option` or `tool_choice` must be present. * @param {number} [params.frequencyPenalty] - Positive values penalize new tokens based on their * existing frequency in the text so far, decreasing the model's likelihood to repeat the same * line verbatim. * @param {boolean} [params.logprobs] - Whether to return log probabilities of the output tokens * or not. If true, returns the log probabilities of each output token returned in the content * of message. * @param {number} [params.topLogprobs] - An integer specifying the number of most likely tokens * to return at each token position, each with an associated log probability. The option * `logprobs` must be set to `true` if this parameter is used. * @param {number} [params.maxTokens] - The maximum number of tokens that can be generated in the * chat completion. The total length of input tokens and generated tokens is limited by the * model's context length. * @param {number} [params.n] - How many chat completion choices to generate for each input * message. Note that you will be charged based on the number of generated tokens across all of * the choices. Keep n as 1 to minimize costs. * @param {number} [params.presencePenalty] - Positive values penalize new tokens based on whether * they appear in the text so far, increasing the model's likelihood to talk about new topics. * @param {TextChatResponseFormat} [params.responseFormat] * * - The chat response format parameters. * * @param {number} [params.temperature] - What sampling temperature to use,. Higher values like * 0.8 will make the output more random, while lower values like 0.2 will make it more focused * and deterministic. * * We generally recommend altering this or `top_p` but not both. * @param {number} [params.topP] - An alternative to sampling with temperature, called nucleus * sampling, where the model considers the results of the tokens with top_p probability mass. So * 0.1 means only the tokens comprising the top 10% probability mass are considered. * * We generally recommend altering this or `temperature` but not both. * @param {number} [params.timeLimit] - Time limit in milliseconds * * - If not completed within this time, generation will stop. The text generated so far will be * returned along with the `TIME_LIMIT`` stop reason. Depending on the users plan, and on * the model being used, there may be an enforced maximum time limit. * * @param {number} [params.repetitionPenalty] - Represents the penalty for penalizing tokens that * have already been generated or belong to the context. * @param {number} [params.lengthPenalty] - Exponential penalty to the length that is used with * beam-based generation. It is applied as an exponent to the sequence length, which in turn is * used to divide the score of the sequence. Since the score is the log likelihood of the * sequence (i.e. negative), `lengthPenalty` > 0.0 promotes longer sequences, while * `lengthPenalty` < 0.0 encourages shorter sequences. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {boolean} [params.returnObject] - Flag that indicates return type. Set 'true' to return * objects. * @param {WatsonXAI.RequestCallbacks>} callbacks * - The object containing callbacks for requests and response * * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>>} * Return * * - Promise resolving to Stream object. Stream object is AsyncIterable based class. Stream object * contains an additional property holding an AbortController, read more below. * * @returns {AbortController} Return.controller - Abort controller. Allows user to abort when * reading from stream without transition to Readable */ textChatStream(params: WatsonXAI.TextChatStreamParams & { returnObject?: false; }, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; textChatStream(params: WatsonXAI.TextChatStreamParams & { returnObject: true; }, callbacks?: WatsonXAI.RequestCallbacks>): Promise>>; /** TextEmbeddings */ /** * Generate embeddings. * * Generate embeddings from text input. * * See the * [documentation](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-embed-overview.html?context=wx&audience=wdp) * for a description of text embeddings. * * @category Embeddings * @param {Object} params - The parameters to send to the service. * @param {string} params.modelId - The `id` of the model to be used for this request. Please * refer to the [list of * models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp). * @param {string[]} params.inputs - The input text. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {EmbeddingParameters} [params.parameters] - Parameters for text embedding requests. * @param {Crypto} [params.crypto] - Encryption configuration for securing inference requests. * Contains `key_ref` (identifier of the DEK in the keys management service IBM Key Protect CRN * format). * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {WatsonXAI.RequestCallbacks>} callbacks * - The object containing callbacks for requests and response * * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>} A Promise that resolves to * an embeddings response */ embedText(params: WatsonXAI.TextEmbeddingsParams, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; /** CreateTextExtraction */ /** * Start a text extraction request. * * Start a request to extract text and metadata from documents. * * See the * [documentation](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-api-text-extraction.html?context=wx&audience=wdp) * for a description of text extraction. * * @param {Object} params - The parameters to send to the service. * @param {TextExtractionDataReference} params.documentReference * * - A reference to data. * * @param {TextExtractionDataReference} params.resultsReference * * - A reference to data. * * @param {TextExtractionSteps} [params.steps] - The steps for the text extraction pipeline. * @param {JsonObject} [params.assemblyJson] - Set this as an empty object to specify `json` * output. * * Note that this is not strictly required because if an `assembly_md` object is not found then * the default will be `json`. * @param {JsonObject} [params.assemblyMd] - Set this as an empty object to specify `markdown` * output. * @param {JsonObject} [params.custom] - User defined properties specified as key-value pairs. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a text extraction response */ createTextExtraction(params: WatsonXAI.TextExtractionParams): Promise>; /** * Retrieve the text extraction requests. * * Retrieve the list of text extraction requests for the specified space or project. * * This operation does not save the history, any requests that were deleted or purged will not * appear in this list. * * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.start] - Token required for token-based pagination. This token cannot * be determined by end user. It is generated by the service and it is set in the href available * in the `next` field. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to text extraction resources */ listTextExtractions(params?: WatsonXAI.ListTextExtractionsParams): Promise>; /** * Get the results of the request. * * Retrieve the text extraction request with the specified identifier. * * Note that there is a retention period of 2 days. If this retention period is exceeded then the * request will be deleted and the results no longer available. In this case this operation will * return `404`. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the extraction request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a text extraction response */ getTextExtraction(params: WatsonXAI.TextExtractionGetParams): Promise>; /** * Delete the request. * * Cancel the specified text extraction request and delete any associated results. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the extraction request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job or request * metadata. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deleteTextExtraction(params: WatsonXAI.TextExtractionDeleteParams): Promise>; /** Schema Management */ /** * Start a create schema request. * * Start a request to create the custom schema for text extraction. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {TextExtractionDataReference} params.documentReference - A reference to data. * @param {CreateSchemaParameters} [params.parameters] - The parameters for the create schema. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ runCreateSchemaJob(params: Types.CreateSchemaParams): Promise>; /** * List create schema requests. * * Retrieve the list of create schema requests for the specified space or project. * * @category Schema Management * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.start] - Token required for token-based pagination. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listCreateSchemaJobs(params?: Types.ListCreateSchemaParams): Promise>; /** * Get a create schema request. * * Retrieve the create schema request details with the specified identifier. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the create schema request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getCreateSchemaJob(params: Types.GetCreateSchemaParams): Promise>; /** * Delete a create schema request. * * Delete the create schema request with the specified identifier. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the create schema request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job or request * metadata. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ deleteCreateSchemaJob(params: Types.DeleteCreateSchemaParams): Promise>; /** * Start an improve schema request. * * Start a request to improve an existing schema for text extraction. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {ImproveSchemaParameters} params.parameters - The parameters to improve schema. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ runImproveSchemaJob(params: Types.ImproveSchemaParams): Promise>; /** * List improve schema requests. * * Retrieve the list of improve schema requests for the specified space or project. * * @category Schema Management * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.start] - Token required for token-based pagination. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listImproveSchemaJobs(params?: Types.ListImproveSchemaParams): Promise>; /** * Get an improve schema request. * * Retrieve the improve schema request details with the specified identifier. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the improve schema request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getImproveSchemaJob(params: Types.GetImproveSchemaParams): Promise>; /** * Delete an improve schema request. * * Delete the improve schema request with the specified identifier. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the improve schema request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job or request * metadata. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ deleteImproveSchemaJob(params: Types.DeleteImproveSchemaParams): Promise>; /** * Start a merge schema request. * * Start a request to merge multiple schemas for text extraction. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {MergeSchemaParameters} params.parameters - The parameters to merge schema. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ runMergeSchemaJob(params: Types.MergeSchemaParams): Promise>; /** * List merge schema requests. * * Retrieve the list of merge schema requests for the specified space or project. * * @category Schema Management * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.start] - Token required for token-based pagination. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listMergeSchemaJobs(params?: Types.ListMergeSchemaParams): Promise>; /** * Get a merge schema request. * * Retrieve the merge schema request details with the specified identifier. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the merge schema request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getMergeSchemaJob(params: Types.GetMergeSchemaParams): Promise>; /** * Delete a merge schema request. * * Delete the merge schema request with the specified identifier. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the merge schema request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job or request * metadata. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ deleteMergeSchemaJob(params: Types.DeleteMergeSchemaParams): Promise>; /** * Start a cluster schema request. * * Start a request to cluster multiple schemas for text extraction. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {ClusterSchemaParameters} params.parameters - The parameters to cluster schemas. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ runClusterSchemaJob(params: Types.ClusterSchemaParams): Promise>; /** * List cluster schema requests. * * Retrieve the list of cluster schema requests for the specified space or project. * * @category Schema Management * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.start] - Token required for token-based pagination. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ listClusterSchemaJobs(params?: Types.ListClusterSchemaParams): Promise>; /** * Get a cluster schema request. * * Retrieve the cluster schema request details with the specified identifier. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the cluster schema request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ getClusterSchemaJob(params: Types.GetClusterSchemaParams): Promise>; /** * Delete a cluster schema request. * * Delete the cluster schema request with the specified identifier. * * @category Schema Management * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the cluster schema request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job or request * metadata. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} */ deleteClusterSchemaJob(params: Types.DeleteClusterSchemaParams): Promise>; /** TextGeneration */ /** * Infer text. * * Infer the next tokens for a given deployed model with a set of parameters. * * @category Text Generation * @param {Object} params - The parameters to send to the service. * @param {string} params.input - The prompt to generate completions. Note: The method tokenizes * the input internally. It is recommended not to leave any trailing spaces. * @param {string} params.modelId - The `id` of the model to be used for this request. Please * refer to the [list of * models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models.html?context=wx). * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {TextGenParameters} [params.parameters] - Properties that control the model and * response. * @param {Moderations} [params.moderations] - Properties that control the moderations, for usages * such as `Hate and profanity` (HAP) and `Personal identifiable information` (PII) filtering. * This list can be extended with new types of moderations. * @param {Crypto} [params.crypto] - Encryption configuration for securing inference requests. * Contains `key_ref` (identifier of the DEK in the keys management service IBM Key Protect CRN * format). * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {WatsonXAI.RequestCallbacks>} callbacks * - The object containing callbacks for requests and response * * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>} A Promise that resolves to a * text generation response */ generateText(params: WatsonXAI.TextGenerationParams, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; /** * Infer text event stream. * * Infer the next tokens for a given deployed model with a set of parameters. This operation will * return the output tokens as a stream of events. * * ### Response * * Stream> represents a source of * streaming data. If request performed successfully Stream> returns either stream line by line. Output * will stream as follow: * * - Id: 1 * - Event: message * - Data: {data} * - Empty line which separates the next Event Message * * Or stream of objects. Output will stream as follow: { id: , event: 'message', data: {data} } * * Here is one of the possibilities to read streaming output: * * Const stream = await watsonxAIServiceenerateTextStream(parameters); for await (const line of * stream) { console.log(line); } * * @category Text Generation * @param {Object} params - The parameters to send to the service. * @param {string} params.input - The prompt to generate completions. Note: The method tokenizes * the input internally. It is recommended not to leave any trailing spaces. * @param {string} params.modelId - The `id` of the model to be used for this request. Please * refer to the [list of * models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models.html?context=wx). * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {TextGenParameters} [params.parameters] - Properties that control the model and * response. * @param {Moderations} [params.moderations] - Properties that control the moderations, for usages * such as `Hate and profanity` (HAP) and `Personal identifiable information` (PII) filtering. * This list can be extended with new types of moderations. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {boolean} [params.returnObject] - Flag that indicates return type. Set 'true' to return * objects. * @param {Object} callbacks - The parameters to send to the service. * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>>} * Return * * - Promise resolving to Stream object. Stream object is AsyncIterable based class. Stream object * contains an additional property holding an AbortController, read more below. * * @returns {AbortController} Return.controller - Abort controller. Allows user to abort when * reading from stream without transition to Readable */ generateTextStream(params: WatsonXAI.TextGenerationStreamParams & { returnObject?: false; }, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; generateTextStream(params: WatsonXAI.TextGenerationStreamParams & { returnObject: true; }, callbacks?: WatsonXAI.RequestCallbacks>): Promise>>; /** Tokenization */ /** * Text tokenization. * * The text tokenize operation allows you to check the conversion of provided input to tokens for * a given model. It splits text into words or sub-words, which then are converted to ids through * a look-up table (vocabulary). Tokenization allows the model to have a reasonable vocabulary * size. * * @category Tokenization * @param {Object} params - The parameters to send to the service. * @param {string} params.modelId - The `id` of the model to be used for this request. Please * refer to the [list of * models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models.html?context=wx). * @param {string} params.input - The input string to tokenize. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {TextTokenizeParameters} [params.parameters] - The parameters for text tokenization. * @param {Crypto} [params.crypto] - Encryption configuration for securing inference requests. * Contains `key_ref` (identifier of the DEK in the keys management service IBM Key Protect CRN * format). * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves * to a tokenization response */ tokenizeText(params: WatsonXAI.TextTokenizationParams): Promise>; /** TimeSeriesTechPreview */ /** * Time series forecast. * * Generate forecasts, or predictions for future time points, given historical time series data. * * @param {Object} params - The parameters to send to the service. * @param {string} params.modelId - The model to be used for generating a forecast. * @param {JsonObject} params.data - 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. * @param {TSForecastInputSchema} params.schema - Contains metadata about your timeseries data * input. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {TSForecastParameters} [params.parameters] - The parameters for the forecast request. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to * a time series forecast response */ timeSeriesForecast(params: WatsonXAI.TimeSeriesForecastParams): Promise>; /** Trainings */ /** * Create a new watsonx.ai training. * * Create a new watsonx.ai training in a project or a space. * * The details of the base model and parameters for the training must be provided in the * `prompt_tuning` object. * * In order to deploy the tuned model you need to follow the following steps: * * 1. Create a WML model asset, in a space or a project, by providing the `request.json` as shown * below: * * curl -X POST "https://{cpd_cluster}/ml/v4/models?version=2024-01-29" \ * -H "Authorization: Bearer " \ * -H "content-type: application/json" \ * --data '{ * "name": "replace_with_a_meaningful_name", * "space_id": "replace_with_your_space_id", * "type": "prompt_tune_1.0", * "software_spec": { * "name": "watsonx-textgen-fm-1.0" * }, * "metrics": [ from the training job ], * "training": { * "id": "05859469-b25b-420e-aefe-4a5cb6b595eb", * "base_model": { * "model_id": "google/flan-t5-xl" * }, * "task_id": "generation", * "verbalizer": "Input: {{input}} Output:" * }, * "training_data_references": [ * { * "connection": { * "id": "20933468-7e8a-4706-bc90-f0a09332b263" * }, * "id": "file_to_tune1.json", * "location": { * "bucket": "wxproject-donotdelete-pr-xeyivy0rx3vrbl", * "path": "file_to_tune1.json" * }, * "type": "connection_asset" * } * ] * }' * ``` * * * Notes: * * 1. If you used the training request field `auto_update_model: true` then you can skip this step as * the model will have been saved at the end of the training job. * 2. Rather than creating the payload for the model you can use the generated `request.json` that * was stored in the `results_reference` field, look for the path in the field * `entity.results_reference.location.model_request_path`. * 3. The model `type` must be `prompt_tune_1.0`. * 4. The software spec name must be `watsonx-textgen-fm-1.0`. * 2. Create a tuned model deployment as described in the [create deployment * documentation](#create-deployment). * * @category Trainings @param {Object} params - The parameters to send to the service. @param * {string} params.name - The name of the training. @param {ObjectLocation} * params.resultsReference - The training results. Normally this is specified as `type=container` * which means that it is stored in the space or project. @param {string} [params.spaceId] - The * space that contains the resource. Either `space_id` or `project_id` has to be given. @param * {string} [params.projectId] - The project that contains the resource. Either `space_id` or * `project_id` has to be given. @param {string} [params.description] - A description of the * training. @param {string[]} [params.tags] - A list of tags for this resource. @param * {PromptTuning} [params.promptTuning] - Properties to control the prompt tuning. @param * {DataConnectionReference[]} [params.trainingDataReferences] * * - Training datasets. * * @param {JsonObject} [params.custom] - User defined properties specified as key-value pairs. * @param {boolean} [params.autoUpdateModel] - If set to `true` then the result of the training, * if successful, will be uploaded to the repository as a model. @param {OutgoingHttpHeaders} * [params.headers] - Custom request headers @returns * {Promise>} A Promise that resolves to a training * resource * * @category Trainings */ createTraining(params: WatsonXAI.TrainingsCreateParams): Promise>; /** * Retrieve the list of trainings. * * Retrieve the list of trainings for the specified space or project. * * @category Trainings * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.start] - Token required for token-based pagination. This token cannot * be determined by end user. It is generated by the service and it is set in the href available * in the `next` field. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {boolean} [params.totalCount] - Compute the total count. May have performance impact. * @param {string} [params.tagValue] - Return only the resources with the given tag value. * @param {string} [params.state] - Filter based on on the training job state. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a collection of training resources */ listTrainings(params?: WatsonXAI.TrainingsListParams): Promise>; /** * Retrieve the training. * * Retrieve the training with the specified identifier. * * @category Trainings * @param {Object} params - The parameters to send to the service. * @param {string} params.trainingId - The training identifier. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * training resource */ getTraining(params: WatsonXAI.TrainingsGetParams): Promise>; /** * Cancel or delete the training. * * Cancel the specified training and remove it. * * @category Trainings * @param {Object} params - The parameters to send to the service. * @param {string} params.trainingId - The training identifier. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job or request * metadata. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deleteTraining(params: WatsonXAI.TrainingsDeleteParams): Promise>; /** TextRerank */ /** * Generate rerank. * * Rerank texts based on some queries. * * @category Text Rerank * @param {Object} params - The parameters to send to the service. * @param {string} params.modelId - The `id` of the model to be used for this request. Please * refer to the [list of * models](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/fm-models-embed.html?context=wx&audience=wdp). * @param {RerankInput[]} params.inputs - The rank input strings. * @param {string} params.query - The rank query. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {RerankParameters} [params.parameters] - The properties used for reranking. * @param {Crypto} [params.crypto] - Encryption configuration for securing inference requests. * Contains `key_ref` (identifier of the DEK in the keys management service IBM Key Protect CRN * format). * @param {OutgoingHttpHeaders} [params.headers] - Custom request header * @param {Object} callbacks - The parameters to send to the service. * @param {InvokeRequestCallback} [callbacks.requestCallback] - Callback invoked with paramteres * payload for API call * @param {ReceiveResponseCallback} [callbacks.responseCallback] - Callback invoked with * paramteres response from API call * @returns {Promise>} A Promise that resolves to a * rerank response */ textRerank(params: WatsonXAI.TextRerankParams, callbacks?: WatsonXAI.RequestCallbacks>): Promise>; /** FineTunings */ /** * Create a fine tuning job. * * Create a fine tuning job that will fine tune an LLM. * * @param {Object} params - The parameters to send to the service. * @param {string} params.name - The name of the job. * @param {ObjectLocation[]} params.trainingDataReferences * * - The training datasets. * * @param {ObjectLocation} params.resultsReference - The training results. Normally this is * specified as `type=container` which means that it is stored in the space or project. * @param {string} [params.description] - The description of the job. * @param {string[]} [params.tags] - A list of tags for this resource. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {boolean} [params.autoUpdateModel] - This field must not be set while creating a fine * tuning job with InstructLab. * * If set to `true` then the result of the training, if successful, will be uploaded to the * repository as a model. * @param {FineTuningParameters} [params.parameters] - This field must not be set while creating a * fine tuning job with InstructLab. * * The parameters for the job. Note that if `verbalizer` is provided then `response_template` must * also be provided (and vice versa). * @param {string} [params.type] - The `type` of Fine Tuning training. The `type` is set to `ilab` * for InstructLab training. * @param {ObjectLocation[]} [params.testDataReferences] * * - This field must not be set while creating a fine tuning job with InstructLab. * * The holdout/test datasets. * @param {JsonObject} [params.custom] - User defined properties specified as key-value pairs. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to * a fine-tuning resource */ createFineTuning(params: WatsonXAI.CreateFineTuningParams): Promise>; /** * Retrieve the list of fine tuning jobs. * * Retrieve the list of fine tuning jobs for the specified space or project. * * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.start] - Token required for token-based pagination. This token cannot * be determined by end user. It is generated by the service and it is set in the href available * in the `next` field. * @param {number} [params.limit] - How many resources should be returned. * @param {boolean} [params.totalCount] - Compute the total count. May have performance impact. * @param {string} [params.tagValue] - Return only the resources with the given tag value. * @param {string} [params.state] - Filter based on on the job state: queued, running, completed, * failed etc. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves * to fine-tuning resources */ listFineTunings(params?: WatsonXAI.FineTuningListParams): Promise>; /** * Get a fine tuning job. * * Get the results of a fine tuning job, or details if the job failed. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The `id` is the identifier that was returned in the `metadata.id` * field of the request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to * a fine-tuning resource */ getFineTuning(params: WatsonXAI.GetFineTuningParams): Promise>; /** * Cancel or delete a fine tuning job. * * Delete a fine tuning job if it exists, once deleted all trace of the job is gone. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The `id` is the identifier that was returned in the `metadata.id` * field of the request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job or request * metadata. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deleteFineTuning(params: WatsonXAI.DeleteFineTuningParams): Promise>; /** DocumentExtractionTechPreview */ /** * Create a document extraction. * * Create a document extraction. * * @param {Object} params - The parameters to send to the service. * @param {string} params.name - The name of the document. * @param {DocumentExtractionObjectLocation[]} params.documentReferences * * - The documents for text extraction. * * @param {ObjectLocationGithub} params.resultsReference * * - A reference to data. * * @param {string[]} [params.tags] - A list of tags for this resource. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a document extraction resource */ createDocumentExtraction(params: WatsonXAI.CreateDocumentExtractionParams): Promise>; /** * Get document extractions. * * Get document extractions. * * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to document extraction resources */ listDocumentExtractions(params: WatsonXAI.ListDocumentExtractionsParams): Promise>; /** * Get document extraction. * * Get document extraction. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The `id` is the identifier that was returned in the `metadata.id` * field of the request. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a document extraction resource */ getDocumentExtraction(params: WatsonXAI.GetDocumentExtractionParams): Promise>; /** * Cancel the document extraction. * * Cancel the specified document extraction and remove it. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The `id` is the identifier that was returned in the `metadata.id` * field of the request. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job metadata * information. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ cancelDocumentExtractions(params: WatsonXAI.CancelDocumentExtractionsParams): Promise>; /** SyntheticDataGenerationTechPreview */ /** * Create a synthetic data generation job. * * Create a synthetic data generation job. * * @param {Object} params - The parameters to send to the service. * @param {string} params.name - The name of the data. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {SyntheticDataGenerationDataReference} [params.dataReference] * * - A reference to data. * * @param {ObjectLocation} [params.resultsReference] - A reference to data. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise * that resolves to a synthetic data generation resource */ createSyntheticDataGeneration(params: WatsonXAI.CreateSyntheticDataGenerationParams): Promise>; /** * Get synthetic data generation jobs. * * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise * that resolves to synthetic data generation resources */ listSyntheticDataGenerations(params: WatsonXAI.ListSyntheticDataGenerationsParams): Promise>; /** * Get synthetic data generation job. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The `id` is the identifier that was returned in the `metadata.id` * field of the request. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise * that resolves to a synthetic data generation resource */ getSyntheticDataGeneration(params: WatsonXAI.GetSyntheticDataGenerationParams): Promise>; /** * Cancel the synthetic data generation. * * Cancel the synthetic data generation and remove it. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The `id` is the identifier that was returned in the `metadata.id` * field of the request. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job metadata * information. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ cancelSyntheticDataGeneration(params: WatsonXAI.CancelSyntheticDataGenerationParams): Promise>; /** TaxonomyTechPreview */ /** * Create a taxonomy job. * * Create a taxonomy job. * * @param {Object} params - The parameters to send to the service. * @param {string} params.name - The name of the document. * @param {string} [params.description] - The description of the Taxonomy job. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {ObjectLocation} [params.dataReference] - A reference to data. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * taxonomy resource */ createTaxonomy(params: WatsonXAI.CreateTaxonomyParams): Promise>; /** * Get taxonomy jobs. * * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to * taxonomy resources */ listTaxonomies(params?: WatsonXAI.ListTaxonomiesParams): Promise>; /** * Get taxonomy job. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The `id` is the identifier that was returned in the `metadata.id` * field of the request. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * taxonomy resource */ getTaxonomy(params: WatsonXAI.GetTaxonomyParams): Promise>; /** * Cancel or delete the taxonomy job. * * Cancel or delete the taxonomy job. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The `id` is the identifier that was returned in the `metadata.id` * field of the request. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to `true` in order to also delete the job metadata * information. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deleteTaxonomy(params: WatsonXAI.DeleteTaxonomyParams): Promise>; /** Models */ /** * Create a new model. * * Create a new model with the given payload. A model represents a machine learning model asset. * If a `202` status is returned then the model will be ready when the `content_import_state` in * the model status (/ml/v4/models/{model_id}) is `completed`. If `content_import_state` is not * used then a `201` status is returned. * * @param {Object} params - The parameters to send to the service. * @param {string} params.name - The name of the resource. * @param {string} params.type - The model type. The supported model types can be found in the * documentation * [here](https://dataplatform.cloud.ibm.com/docs/content/wsj/wmls/wmls-deploy-python-types.html?context=analytics). * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.description] - A description of the resource. * @param {string[]} [params.tags] - A list of tags for this resource. * @param {SoftwareSpecRel} [params.softwareSpec] - A software specification. * @param {Rel} [params.pipeline] - A reference to a resource. * @param {ModelDefinitionId} [params.modelDefinition] - The model definition. * @param {JsonObject} [params.hyperParameters] - Hyper parameters used for training this model. * @param {string} [params.domain] - User provided domain name for this model. For example: * sentiment, entity, visual-recognition, finance, retail, real estate etc. * @param {DataConnectionReference[]} [params.trainingDataReferences] * * - The training data that was used to create this model. * * @param {DataConnectionReference[]} [params.testDataReferences] The holdout/test datasets. * @param {ModelEntitySchemas} [params.schemas] - If the prediction schemas are provided here then * they take precedent over any schemas provided in the data references. Note that data * references contain the schema for the associated data and this object contains the schema(s) * for the associated prediction, if any. In the case that the prediction input data matches * exactly the schema of the training data references then the prediction schema can be omitted. * However it is highly recommended to always specify the prediction schemas using this field. * @param {string} [params.labelColumn] - The name of the label column. * @param {string} [params.transformedLabelColumn] - The name of the label column seen by the * estimator, which may have been transformed by the previous transformers in the pipeline. This * is not necessarily the same column as the `label_column` in the initial data set. * @param {ModelEntitySize} [params.size] - This will be used by scoring to record the size of the * model. * @param {Metric[]} [params.metrics] - Metrics that can be returned by an operation. * @param {JsonObject} [params.custom] - User defined properties specified as key-value pairs. * @param {JsonObject} [params.userDefinedObjects] - User defined objects referenced by the model. * For any user defined class or function used in the model, its name, as referenced in the * model, must be specified as the `key` and its fully qualified class or function name must be * specified as the `value`. This is applicable for `Tensorflow 2.X` models serialized in `H5` * format using the `tf.keras` API. * @param {SoftwareSpecRel[]} [params.hybridPipelineSoftwareSpecs] * * - The list of the software specifications that are used by the pipeline that generated this * model, if the model was generated by a pipeline. * * @param {ModelEntityModelVersion} [params.modelVersion] * * - Optional metadata that can be used to provide information about this model that can be tracked * with IBM AI Factsheets. See [Using AI * Factsheets](https://dataplatform.cloud.ibm.com/docs/content/wsj/analyze-data/factsheets-model-inventory.html) * for more details. * * @param {string} [params.trainingId] - Deprecated: this is replaced by `training.id`. This field * can be used to store the `id` of the training job that was used to produce this model. * @param {DataPreprocessingTransformation[]} [params.dataPreprocessing] * * - An optional array which contains the data preprocessing transformations that were executed by * the training job that created this model. * * @param {TrainingDetails} [params.training] - Information about the training job that created * this model. * @param {ContentLocation} [params.contentLocation] - Details about the attachments that should * be uploaded with this model. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * model resource */ createModel(params: WatsonXAI.ModelsCreateParams): Promise>; /** * Retrieve the models. * * Retrieve the models for the specified space or project. * * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.start] - Token required for token-based pagination. This token cannot * be determined by end user. It is generated by the service and it is set in the href available * in the `next` field. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {string} [params.tagValue] - Return only the resources with the given tag values, * separated by `or` or `and` to support multiple tags. * @param {string} [params.search] - Returns only resources that match this search string. The * path to the field must be the complete path to the field, and this field must be one of the * indexed fields for this resource type. Note that the search string must be URL encoded. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to * model resources */ listModels(params: WatsonXAI.ModelsListParams): Promise>; /** * Retrieve the model. * * Retrieve the model with the specified identifier. If `rev` query parameter is provided, * `rev=latest` will fetch the latest revision. A call with `rev={revision_number}` will fetch the * given revision_number record. Either `space_id` or `project_id` has to be provided and is * mandatory. * * @param {Object} params - The parameters to send to the service. * @param {string} params.modelId - Model identifier. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.rev] - The revision number of the resource. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * model resource */ getModel(params: WatsonXAI.ModelsGetParams): Promise>; /** * Update the model. * * Update the model with the provided patch data. The following fields can be patched: * * - `/tags` * - `/name` * - `/description` * - `/custom` * - `/software_spec` (operation `replace` only) * - `/model_version` (operation `add` and `replace` only). * * @param {Object} params - The parameters to send to the service. * @param {string} params.modelId - Model identifier. * @param {JsonPatchOperation[]} params.jsonPatch - Input For Patch. This is the patch body which * corresponds to the JavaScript Object Notation (JSON) Patch standard (RFC 6902). * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * model resource */ updateModel(params: WatsonXAI.ModelsUpdateParams): Promise>; /** * Delete the model. * * Delete the model with the specified identifier. This will delete all revisions of this model as * well. For each revision all attachments will also be deleted. * * @param {Object} params - The parameters to send to the service. * @param {string} params.modelId - Model identifier. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deleteModel(params: WatsonXAI.ModelsDeleteParams): Promise>; /** UtilityAgentToolsBeta */ /** * Get utility agent tools. * * This retrieves the complete list of supported utility agent tools and contains information * required for running each tool. * * @param {Object} [params] - The parameters to send to the service. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to utility agent tools response */ listUtilityAgentTools(params?: WatsonXAI.GetUtilityAgentToolsParams): Promise>; /** * Get utility agent tool. * * This retrieves the details of an utility agent tool and contains information required for * running the tool. Providing authentication and configuration params may return additional * details. * * @param {Object} params - The parameters to send to the service. * @param {string} params.toolId - Tool name. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * utility agent tool */ getUtilityAgentTool(params: WatsonXAI.GetUtilityAgentToolParams): Promise>; /** * Run a utility agent tool. * * This runs a utility agent tool given an input and optional configuration parameters. * * Some tools can choose to tailor the response based on the access token identity. * * @param {Object} params - The parameters to send to the service. * @param {WxUtilityAgentToolsRunRequest} params.wxUtilityAgentToolsRunRequest - Tool call body * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a utility agent tools run response */ runUtilityAgentTool(params: WatsonXAI.PostUtilityAgentToolsRunParams): Promise>; /** * Run a utility agent tool. * * This runs a utility agent tool given an input and optional configuration parameters. * * Some tools can choose to tailor the response based on the access token identity. * * @param {Object} params - The parameters to send to the service. * @param {string} params.toolId - Tool name. * @param {WxUtilityAgentToolsRunRequest} params.wxUtilityAgentToolsRunRequest - Tool call body * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a utility agent tools run response */ runUtilityAgentToolByName(params: WatsonXAI.PostUtilityAgentToolsRunByNameParams): Promise>; /** Spaces */ /** * Create a new space. * * Creates a new space to scope other assets. Authorized user must have the following roles (see * https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-iams): * * - Platform management role: Administrator * - Service access role: Manager * * On Public Cloud, user is required to provide Cloud Object Storage instance details in the * 'storage' property. On private CPD installations, the default storage is used instead. * * @param {CreateSpaceRequest} params - The parameters to send to the service. * @param {string} params.name - Name of space. * @param {string} [params.description] - Description of space. * @param {CreateSpaceStorage} [params.storage] - Cloud Object Storage instance is required for * spaces created on Public Cloud. On private CPD installations, the default storage is used * instead. This flag is not supported on CPD. * @param {CreateSpaceCompute[]} [params.compute] - This flag is not supported on CPD. * @param {string[]} [params.tags] - User-defined tags associated with a space. * @param {string} [params.generator] - A consistent label used to identify a client that created * a space. A generator must be comprised of the following characters - alphanumeric, dash, * underscore, space. * @param {CreateSpaceStage} [params.stage] - Space production and stage name. * @param {string} [params.type] - Space type. * @param {CreateSpaceSettings} [params.settings] - Space settings. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a * space resource */ createSpace(params: WatsonXAI.CreateSpaceParams): Promise>; /** * Retrieve the space. * * Retrieves the space with the specified identifier. * * @param {GetSpaceParams} [params] - The parameters to send to the service. * @param {string} params.spaceId - The space identification. * @param {string} [params.include] - A list of comma-separated space sections to include in the * query results. Example: '?include=members'. Available fields: members (returns up to 100 * members) nothing (does not return space entity and metadata) * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a space */ getSpace(params: WatsonXAI.GetSpaceParams): Promise>; /** * Delete the space. * * Deletes the space with the specified identifier. * * @param {DeleteSpaceParams} params - The parameters to send to the service. * @param {string} params.spaceId - The space identification. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deleteSpace(params: WatsonXAI.DeleteSpaceParams): Promise>; /** * Update the space. * * Partially update this space. Allowed paths are: * * - /name * - /description * - /compute * - /stage/name * - /type * - /settings/folders/enabled * - /settings/access_restrictions/reporting/authorized * * @param {WatsonXAI.SpacePatchParams} params - The parameters to send to the service. * @param {string} params.spaceId - The space identification. * @param {WatsonXAI.JsonPatchOperation} params.jsonPatch - The patch operation. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to a space */ updateSpace(params: WatsonXAI.SpacePatchParams): Promise>; /** * Retrieve the spaces. * * Retrieves the space list. * * @category Spaces * @param {Object} params - The parameters to send to the service. * @param {string} [params.start] - Token representing first resource. * @param {number} [params.limit] - The number of resources returned. Default value is 100. Max * value is 200. * @param {boolean} [params.totalCount] - Include details about total number of resources. This * flag is not supported on CPD 3.0.1. * @param {string} [params.id] - Comma-separated list of ids to be returned. This flag is not * supported on CPD 3.0.1. * @param {string} [params.tags] - A list of comma-separated, user-defined tags to use to filter * the query results. * @param {string} [params.include] - A list of comma-separated space sections to include in the * query results. Example: '?include=members'. Available fields: * * - Members (returns up to 100 members) * - Nothing (does not return space entity and metadata) * * @param {string} [params.member] - Filters the result list to only include spaces where the user * with a matching user id is a member. * @param {string} [params.roles] - Must be used in conjunction with the member query parameter. * Filters the result set to include only spaces where the specified member has one of the roles * specified. Values: * * - Admin * - Editor * - Viewer * * @param {string} [params.bssAccountId] - Filtering by bss_account_id is allowed only for * accredited services. * @param {string} [params.name] - Filters the result list to only include space with specified * name. * @param {string} [params.subName] - Filters the result list to only include spaces which name * contains specified case-insensitive substring. * @param {string} [params.compute.crn] - Filters the result list to only include spaces with * specified compute.crn. * @param {string} [params.type] - Filters the result list to only include space with specified * type. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to * space resources */ listSpaces(params?: WatsonXAI.ListSpacesParams): Promise>; /** * Transcribes an audio file using the Watson AI ML VML service. * * @param {Object} params - The parameters to send to the service. * @param {string} params.model - The model to use for audio transcriptions. * @param {string | ReadStream} params.file - The path to a mp3 or wav audio file to transcribe or * a ReadStream object containing a file stream: `fs.createReadStream(path)`. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {string} [params.language] - Optional target language to which to transcribe; for * example, fr for French. Default is English. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @param {string} [params.signal] - A list of comma-separated, user-defined tags to use to filter * the query results. * @returns {Promise>} - A promise that resolves * with the transcription response. * @throws {Error} Will throw an error if required or invalid parameters are provided. */ transcribeAudio(params: WatsonXAI.TranscribeAudioParams): Promise>; /** Text classification */ /** * Start a text classification request. * * Start a request to classify text from a document or an image (using OCR). * * @param {Object} params - The parameters to send to the service. * @param {TextClassificationDataReference} params.documentReference * * - A reference to data. * * @param {TextClassificationParameters} params.parameters * * - The parameters for the text extraction. * * @param {JsonObject} [params.custom] - User defined properties specified as key-value pairs. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` has to be given. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a text classification response */ createTextClassification(params: WatsonXAI.TextClassificationParams): Promise>; /** * Retrieve the text classification requests. * * Retrieve the list of text classification requests for the specified space or project. * * This operation does not save the history, any requests that were deleted or purged will not * appear in this list. * * @param {Object} [params] - The parameters to send to the service. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {string} [params.start] - Token required for token-based pagination. This token cannot * be determined by end user. It is generated by the service and it is set in the href available * in the `next` field. * @param {number} [params.limit] - How many resources should be returned. By default limit is * 100. Max limit allowed is 200. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to text classification resources */ listTextClassifications(params?: WatsonXAI.ListTextClassificationsParams): Promise>; /** * Get the results of the request. * * Retrieve the text classification request with the specified identifier. * * Note that there is a retention period of 2 days. If this retention period is exceeded then the * request will be deleted and the results no longer available. In this case this operation will * return `404`. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the classification request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that * resolves to a text classification response */ getTextClassification(params: WatsonXAI.TextClassificationGetParams): Promise>; /** * Delete the request. * * Cancel the specified text classification request and delete any associated results. * * @param {Object} params - The parameters to send to the service. * @param {string} params.id - The identifier of the classification request. * @param {string} [params.spaceId] - The space that contains the resource. Either `space_id` or * `project_id` query parameter has to be given. * @param {string} [params.projectId] - The project that contains the resource. Either `space_id` * or `project_id` query parameter has to be given. * @param {boolean} [params.hardDelete] - Set to true in order to also delete the job or request * metadata. * @param {OutgoingHttpHeaders} [params.headers] - Custom request headers * @returns {Promise>} A Promise that resolves to an * empty response object */ deleteTextClassification(params: WatsonXAI.TextClassificationDeleteParams): Promise>; } /** Interfaces */ declare namespace WatsonXAI { export import Options = Types.Options; export import TokenAuthenticationOptions = BaseTypes.TokenAuthenticationOptions; export import Certificates = BaseTypes.Certificates; export import Certificate = BaseTypes.Certificate; export import HttpsAgentMap = BaseTypes.HttpsAgentMap; export import Response = BaseTypes.Response; export import Callback = BaseTypes.Callback; export import EmptyObject = Types.EmptyObject; export import JsonObject = Types.JsonObject; export import ObjectStreamed = Types.ObjectStreamed; export import DefaultParams = Types.DefaultParams; export import CreateDeploymentParams = Types.CreateDeploymentParams; export import ListDeploymentsParams = Types.ListDeploymentsParams; export import DeploymentsGetParams = Types.DeploymentsGetParams; export import DeploymentsUpdateParams = Types.DeploymentsUpdateParams; export import DeploymentsDeleteParams = Types.DeploymentsDeleteParams; export import DeploymentsTextGenerationParams = Types.DeploymentsTextGenerationParams; export import DeploymentsTextGenerationStreamParams = Types.DeploymentsTextGenerationStreamParams; export import DeploymentsTextChatParams = Types.DeploymentsTextChatParams; export import DeploymentsTextChatStreamParams = Types.DeploymentsTextChatStreamParams; export import DeploymentsTimeSeriesForecastParams = Types.DeploymentsTimeSeriesForecastParams; export import ListFoundationModelSpecsParams = Types.ListFoundationModelSpecsParams; export import ListFoundationModelTasksParams = Types.ListFoundationModelTasksParams; export import PostPromptParams = Types.PostPromptParams; export import GetPromptParams = Types.GetPromptParams; export import CatalogSearch = Types.CatalogSearch; export import PromptListParams = Types.PromptListParams; export import PatchPromptParams = Types.PatchPromptParams; export import DeletePromptParams = Types.DeletePromptParams; export import PutPromptLockParams = Types.PutPromptLockParams; export import GetPromptLockParams = Types.GetPromptLockParams; export import GetPromptInputParams = Types.GetPromptInputParams; export import PostPromptChatItemParams = Types.PostPromptChatItemParams; export import PostPromptSessionParams = Types.PostPromptSessionParams; export import GetPromptSessionParams = Types.GetPromptSessionParams; export import PatchPromptSessionParams = Types.PatchPromptSessionParams; export import DeletePromptSessionParams = Types.DeletePromptSessionParams; export import PostPromptSessionEntryParams = Types.PostPromptSessionEntryParams; export import GetPromptSessionEntriesParams = Types.GetPromptSessionEntriesParams; export import PostPromptSessionEntryChatItemParams = Types.PostPromptSessionEntryChatItemParams; export import PutPromptSessionLockParams = Types.PutPromptSessionLockParams; export import GetPromptSessionLockParams = Types.GetPromptSessionLockParams; export import GetPromptSessionEntryParams = Types.GetPromptSessionEntryParams; export import DeletePromptSessionEntryParams = Types.DeletePromptSessionEntryParams; export import TextChatParams = Types.TextChatParams; export import TextChatStreamParams = Types.TextChatStreamParams; export import TextEmbeddingsParams = Types.TextEmbeddingsParams; export import TextExtractionParams = Types.TextExtractionParams; export import ListTextExtractionsParams = Types.ListTextExtractionsParams; export import TextExtractionGetParams = Types.TextExtractionGetParams; export import TextExtractionDeleteParams = Types.TextExtractionDeleteParams; export import TextGenerationParams = Types.TextGenerationParams; export import TextGenerationStreamParams = Types.TextGenerationStreamParams; export import TextTokenizationParams = Types.TextTokenizationParams; export import TrainingsCreateParams = Types.TrainingsCreateParams; export import TrainingsListParams = Types.TrainingsListParams; export import TrainingsGetParams = Types.TrainingsGetParams; export import TrainingsDeleteParams = Types.TrainingsDeleteParams; export import TextRerankParams = Types.TextRerankParams; export import TimeSeriesForecastParams = Types.TimeSeriesForecastParams; export import CreateFineTuningParams = Types.CreateFineTuningParams; export import FineTuningListParams = Types.FineTuningListParams; export import GetFineTuningParams = Types.GetFineTuningParams; export import DeleteFineTuningParams = Types.DeleteFineTuningParams; export import CreateDocumentExtractionParams = Types.CreateDocumentExtractionParams; export import ListDocumentExtractionsParams = Types.ListDocumentExtractionsParams; export import GetDocumentExtractionParams = Types.GetDocumentExtractionParams; export import CancelDocumentExtractionsParams = Types.CancelDocumentExtractionsParams; export import CreateSyntheticDataGenerationParams = Types.CreateSyntheticDataGenerationParams; export import ListSyntheticDataGenerationsParams = Types.ListSyntheticDataGenerationsParams; export import GetSyntheticDataGenerationParams = Types.GetSyntheticDataGenerationParams; export import CancelSyntheticDataGenerationParams = Types.CancelSyntheticDataGenerationParams; export import CreateTaxonomyParams = Types.CreateTaxonomyParams; export import ListTaxonomiesParams = Types.ListTaxonomiesParams; export import GetTaxonomyParams = Types.GetTaxonomyParams; export import DeleteTaxonomyParams = Types.DeleteTaxonomyParams; export import ModelsCreateParams = Types.ModelsCreateParams; export import ModelsListParams = Types.ModelsListParams; export import ModelsGetParams = Types.ModelsGetParams; export import ModelsUpdateParams = Types.ModelsUpdateParams; export import ModelsDeleteParams = Types.ModelsDeleteParams; export import GetUtilityAgentToolsParams = Types.GetUtilityAgentToolsParams; export import GetUtilityAgentToolParams = Types.GetUtilityAgentToolParams; export import PostUtilityAgentToolsRunParams = Types.PostUtilityAgentToolsRunParams; export import PostUtilityAgentToolsRunByNameParams = Types.PostUtilityAgentToolsRunByNameParams; export import ListSpacesParams = Types.ListSpacesParams; export import CreateSpaceParams = Types.CreateSpaceParams; export import SpaceStorage = Types.SpaceStorage; export import SpaceCompute = Types.SpaceCompute; export import SpaceStage = Types.SpaceStage; export import SpaceSettings = Types.SpaceSettings; export import SpaceMember = Types.SpaceMember; export import GetSpaceParams = Types.GetSpaceParams; export import DeleteSpaceParams = Types.DeleteSpaceParams; export import SpacePatchOperation = Types.SpacePatchOperation; export import SpacePatchParams = Types.SpacePatchParams; export import TranscribeAudioParams = Types.TranscribeAudioParams; export import TextClassificationParams = Types.TextClassificationParams; export import ListTextClassificationsParams = Types.ListTextClassificationsParams; export import TextClassificationGetParams = Types.TextClassificationGetParams; export import TextClassificationDeleteParams = Types.TextClassificationDeleteParams; export import ApiError = Types.ApiError; export import ApiErrorResponse = Types.ApiErrorResponse; export import ApiErrorTarget = Types.ApiErrorTarget; export import BaseModel = Types.BaseModel; export import ConsumptionsLimit = Types.ConsumptionsLimit; export import DataConnection = Types.DataConnection; export import CosDataConnection = Types.CosDataConnection; export import CosDataLocation = Types.CosDataLocation; export import DataConnectionReference = Types.DataConnectionReference; export import DataSchema = Types.DataSchema; export import DeploymentEntity = Types.DeploymentEntity; export import DeploymentResource = Types.DeploymentResource; export import DeploymentResourceCollection = Types.DeploymentResourceCollection; export import DeploymentResourcePatch = Types.DeploymentResourcePatch; export import DeploymentStatus = Types.DeploymentStatus; export import DeploymentSystem = Types.DeploymentSystem; export import DeploymentSystemDetails = Types.DeploymentSystemDetails; export import DeploymentTextChatMessages = Types.DeploymentTextChatMessages; export import DeploymentTextGenProperties = Types.DeploymentTextGenProperties; export import DeploymentTSForecastParameters = Types.DeploymentTSForecastParameters; export import Embedding = Types.Embedding; export import EmbeddingParameters = Types.EmbeddingParameters; export import EmbeddingReturnOptions = Types.EmbeddingReturnOptions; export import EmbeddingsResponse = Types.EmbeddingsResponse; export import ExternalInformationExternalModel = Types.ExternalInformationExternalModel; export import ExternalInformationExternalPrompt = Types.ExternalInformationExternalPrompt; export import ExternalPromptAdditionalInformationItem = Types.ExternalPromptAdditionalInformationItem; export import FoundationModel = Types.FoundationModel; export import FoundationModelLimits = Types.FoundationModelLimits; export import FoundationModelTask = Types.FoundationModelTask; export import FoundationModelTasks = Types.FoundationModelTasks; export import FoundationModelVersion = Types.FoundationModelVersion; export import FoundationModels = Types.FoundationModels; export import GetPromptInputResponse = Types.GetPromptInputResponse; export import HardwareRequest = Types.HardwareRequest; export import HardwareSpec = Types.HardwareSpec; export import Inference = Types.Inference; export import JsonPatchOperation = Types.JsonPatchOperation; export import LifeCycleState = Types.LifeCycleState; export import MaskProperties = Types.MaskProperties; export import Message = Types.Message; export import MetricsContext = Types.MetricsContext; export import ModelLimits = Types.ModelLimits; export import ModelRel = Types.ModelRel; export import ModerationHapProperties = Types.ModerationHapProperties; export import ModerationPiiProperties = Types.ModerationPiiProperties; export import ModerationProperties = Types.ModerationProperties; export import ModerationResult = Types.ModerationResult; export import ModerationResults = Types.ModerationResults; export import ModerationTextRange = Types.ModerationTextRange; export import Moderations = Types.Moderations; export import ObjectLocation = Types.ObjectLocation; export import OnlineDeployment = Types.OnlineDeployment; export import OnlineDeploymentParameters = Types.OnlineDeploymentParameters; export import PaginationFirst = Types.PaginationFirst; export import PaginationNext = Types.PaginationNext; export import PromptModelParameters = Types.PromptModelParameters; export import PromptTuning = Types.PromptTuning; export import PromptTuningMetricsContext = Types.PromptTuningMetricsContext; export import PromptWithExternalModelParameters = Types.PromptWithExternalModelParameters; export import Rel = Types.Rel; export import RerankInput = Types.RerankInput; export import RerankParameters = Types.RerankParameters; export import RerankResponse = Types.RerankResponse; export import RerankReturnOptions = Types.RerankReturnOptions; export import RerankedResults = Types.RerankedResults; export import ResourceCommitInfo = Types.ResourceCommitInfo; export import ResourceMeta = Types.ResourceMeta; export import ReturnOptionProperties = Types.ReturnOptionProperties; export import SimpleRel = Types.SimpleRel; export import Stats = Types.Stats; export import SystemDetails = Types.SystemDetails; export import TaskBenchmark = Types.TaskBenchmark; export import TaskBenchmarkDataset = Types.TaskBenchmarkDataset; export import TaskBenchmarkMetric = Types.TaskBenchmarkMetric; export import TaskBenchmarkPrompt = Types.TaskBenchmarkPrompt; export import TaskDescription = Types.TaskDescription; export import TaskRating = Types.TaskRating; export import TextChatFunctionCall = Types.TextChatFunctionCall; export import TextChatMessages = Types.TextChatMessages; export import TextChatParameterFunction = Types.TextChatParameterFunction; export import TextChatParameterTools = Types.TextChatParameterTools; export import TextChatResponse = Types.TextChatResponse; export import TextChatStreamResponse = Types.TextChatStreamResponse; export import TextChatResponseFormat = Types.TextChatResponseFormat; export import TextChatResultChoice = Types.TextChatResultChoice; export import TextChatStreamResultChoice = Types.TextChatStreamResultChoice; export import TextChatResultMessage = Types.TextChatResultMessage; export import TextChatResultDelta = Types.TextChatResultDelta; export import TextChatResultChoiceStream = Types.TextChatResultChoiceStream; export import TextChatStreamItem = Types.TextChatStreamItem; export import TextChatToolCall = Types.TextChatToolCall; export import TextChatToolChoiceTool = Types.TextChatToolChoiceTool; export import TextChatToolFunction = Types.TextChatToolFunction; export import TextChatUsage = Types.TextChatUsage; export import TextChatUserContents = Types.TextChatUserContents; export import TextChatUserImageURL = Types.TextChatUserImageURL; export import TextExtractionDataReference = Types.TextExtractionDataReference; export import TextExtractionMetadata = Types.TextExtractionMetadata; export import TextExtractionResource = Types.TextExtractionResource; export import TextExtractionResourceEntity = Types.TextExtractionResourceEntity; export import TextExtractionResources = Types.TextExtractionResources; export import TextExtractionResponse = Types.TextExtractionResponse; export import TextExtractionResults = Types.TextExtractionResults; export import ServiceError = Types.ServiceError; export import TextExtractionStepOcr = Types.TextExtractionStepOcr; export import TextExtractionStepTablesProcessing = Types.TextExtractionStepTablesProcessing; export import TextExtractionSteps = Types.TextExtractionSteps; export import TextGenLengthPenalty = Types.TextGenLengthPenalty; export import TextGenParameters = Types.TextGenParameters; export import TextGenResponse = Types.TextGenResponse; export import TextGenResponseFieldsResultsItem = Types.TextGenResponseFieldsResultsItem; export import TextGenTokenInfo = Types.TextGenTokenInfo; export import TextGenTopTokenInfo = Types.TextGenTopTokenInfo; export import TextModeration = Types.TextModeration; export import TextModerationWithoutThreshold = Types.TextModerationWithoutThreshold; export import TextTokenizeParameters = Types.TextTokenizeParameters; export import TextTokenizeResponse = Types.TextTokenizeResponse; export import TextTokenizeResult = Types.TextTokenizeResult; export import TSForecastInputSchema = Types.TSForecastInputSchema; export import TSForecastParameters = Types.TSForecastParameters; export import TSForecastResponse = Types.TSForecastResponse; export import TrainingAccumulatedSteps = Types.TrainingAccumulatedSteps; export import TrainingBatchSize = Types.TrainingBatchSize; export import TrainingInitMethod = Types.TrainingInitMethod; export import TrainingInitText = Types.TrainingInitText; export import TrainingLearningRate = Types.TrainingLearningRate; export import TrainingMaxInputTokens = Types.TrainingMaxInputTokens; export import TrainingMaxOutputTokens = Types.TrainingMaxOutputTokens; export import TrainingMetric = Types.TrainingMetric; export import TrainingNumEpochs = Types.TrainingNumEpochs; export import TrainingNumVirtualTokens = Types.TrainingNumVirtualTokens; export import TrainingParameters = Types.TrainingParameters; export import TrainingResource = Types.TrainingResource; export import TrainingResourceCollection = Types.TrainingResourceCollection; export import TrainingResourceCollectionSystem = Types.TrainingResourceCollectionSystem; export import TrainingResourceEntity = Types.TrainingResourceEntity; export import TrainingStatus = Types.TrainingStatus; export import TrainingTorchDtype = Types.TrainingTorchDtype; export import TrainingVerbalizer = Types.TrainingVerbalizer; export import Warning = Types.Warning; export import WxPromptPatchModelVersion = Types.WxPromptPatchModelVersion; export import WxPromptPostModelVersion = Types.WxPromptPostModelVersion; export import WxPromptResponseModelVersion = Types.WxPromptResponseModelVersion; export import WxPromptSessionEntryListResultsItem = Types.WxPromptSessionEntryListResultsItem; export import ChatItem = Types.ChatItem; export import ExternalInformation = Types.ExternalInformation; export import Prompt = Types.Prompt; export import PromptData = Types.PromptData; export import PromptLock = Types.PromptLock; export import PromptWithExternal = Types.PromptWithExternal; export import UtilityAgentTool = Types.UtilityAgentTool; export import WxPromptResponse = Types.WxPromptResponse; export import CatalogSearchResponseAsset = Types.CatalogSearchResponseAsset; export import ListPromptsResponse = Types.ListPromptsResponse; export import WxPromptSession = Types.WxPromptSession; export import WxPromptSessionEntry = Types.WxPromptSessionEntry; export import WxPromptSessionEntryList = Types.WxPromptSessionEntryList; export import WxUtilityAgentToolsResponse = Types.WxUtilityAgentToolsResponse; export import WxUtilityAgentToolsRunRequest = Types.WxUtilityAgentToolsRunRequest; export import WxUtilityAgentToolsRunResponse = Types.WxUtilityAgentToolsRunResponse; export import TextChatMessagesTextChatMessageAssistant = Types.TextChatMessagesTextChatMessageAssistant; export import TextChatMessagesTextChatMessageSystem = Types.TextChatMessagesTextChatMessageSystem; export import TextChatMessagesTextChatMessageTool = Types.TextChatMessagesTextChatMessageTool; export import TextChatMessagesTextChatMessageUser = Types.TextChatMessagesTextChatMessageUser; export import TextChatUserContentsTextChatUserImageURLContent = Types.TextChatUserContentsTextChatUserImageURLContent; export import TextChatUserContentsTextChatUserTextContent = Types.TextChatUserContentsTextChatUserTextContent; export import RequestParameters = Types.RequestParameters; export import RequestParametersWithoutHeaders = Types.RequestParametersWithoutHeaders; export import InvokeRequestCallback = Types.InvokeRequestCallback; export import ReceiveResponseCallback = Types.ReceiveResponseCallback; export import RequestCallbacks = Types.RequestCallbacks; export import FineTuningEntity = Types.FineTuningEntity; export import FineTuningParameters = Types.FineTuningParameters; export import FineTuningPeftParameters = Types.FineTuningPeftParameters; export import FineTuningResource = Types.FineTuningResource; export import FineTuningResources = Types.FineTuningResources; export import DocumentExtractionResource = Types.DocumentExtractionResource; export import DocumentExtractionResources = Types.DocumentExtractionResources; export import DocumentExtractionResponse = Types.DocumentExtractionResponse; export import DocumentExtractionStatus = Types.DocumentExtractionStatus; export import SyntheticDataGenerationContext = Types.SyntheticDataGenerationContext; export import SyntheticDataGenerationDataReference = Types.SyntheticDataGenerationDataReference; export import SyntheticDataGenerationLocations = Types.SyntheticDataGenerationLocations; export import SyntheticDataGenerationMetric = Types.SyntheticDataGenerationMetric; export import SyntheticDataGenerationMetrics = Types.SyntheticDataGenerationMetrics; export import SyntheticDataGenerationResource = Types.SyntheticDataGenerationResource; export import SyntheticDataGenerationResources = Types.SyntheticDataGenerationResources; export import SyntheticDataGenerationResponse = Types.SyntheticDataGenerationResponse; export import SyntheticDataGenerationSample = Types.SyntheticDataGenerationSample; export import SyntheticDataGenerationStatus = Types.SyntheticDataGenerationStatus; export import TaxonomyResource = Types.TaxonomyResource; export import TaxonomyResources = Types.TaxonomyResources; export import TaxonomyResponse = Types.TaxonomyResponse; export import TaxonomyStatus = Types.TaxonomyStatus; export import SoftwareSpecRel = Types.SoftwareSpecRel; export import TrainingDetails = Types.TrainingDetails; export import DataInput = Types.DataInput; export import DataOutput = Types.DataOutput; export import Metric = Types.Metric; export import MetricTsMetrics = Types.MetricTsMetrics; export import MetricTsadMetrics = Types.MetricTsadMetrics; export import DataPreprocessingTransformation = Types.DataPreprocessingTransformation; export import ModelResourceEntity = Types.ModelResourceEntity; export import ModelResource = Types.ModelResource; export import ModelEntityModelVersion = Types.ModelEntityModelVersion; export import ModelEntitySchemas = Types.ModelEntitySchemas; export import ModelEntitySize = Types.ModelEntitySize; export import ContentInfo = Types.ContentInfo; export import ContentLocation = Types.ContentLocation; export import AudioTranscriptionResult = Types.AudioTranscriptionResult; export import ModelResources = Types.ModelResources; export import ModelDefinitionEntityPlatform = Types.ModelDefinitionEntityPlatform; export import ModelDefinitionEntityRequestPlatform = Types.ModelDefinitionEntityRequestPlatform; export import ModelDefinitionEntity = Types.ModelDefinitionEntity; export import ModelDefinitionId = Types.ModelDefinitionId; export import ModelDefinitionRel = Types.ModelDefinitionRel; export import GPU = Types.GPU; export import DocumentExtractionObjectLocation = Types.DocumentExtractionObjectLocation; export import ObjectLocationGithub = Types.ObjectLocationGithub; export import ErrorResponse = Types.ErrorResponse; export import SpaceResource = Types.SpaceResource; export import SpaceResources = Types.SpaceResources; export import TextClassificationDataReference = Types.TextClassificationDataReference; export import TextClassificationParameters = Types.TextClassificationParameters; export import TextClassificationResource = Types.TextClassificationResource; export import TextClassificationResourceEntity = Types.TextClassificationResourceEntity; export import TextClassificationResources = Types.TextClassificationResources; export import TextClassificationResponse = Types.TextClassificationResponse; export import TextClassificationResults = Types.TextClassificationResults; export import TextClassificationSemanticConfig = Types.TextClassificationSemanticConfig; export import TextExtractionSchema = Types.TextExtractionSchema; export import PostPromptConstants = Types.PostPromptConstants; export import PatchPromptConstants = Types.PatchPromptConstants; export import PutPromptLockConstants = Types.PutPromptLockConstants; export import PostPromptSessionEntryConstants = Types.PostPromptSessionEntryConstants; export import PutPromptSessionLockConstants = Types.PutPromptSessionLockConstants; export import TextChatConstants = Types.TextChatConstants; export import TextChatStreamConstants = Types.TextChatStreamConstants; export import TrainingsListConstants = Types.TrainingsListConstants; export import CreateFineTuningConstants = Types.CreateFineTuningConstants; /** Pager classes */ /** * Abstract base class for all pager implementations. Provides common pagination functionality for * list operations. * * @abstract * @template TResource - The type of resource being paginated * @template TParams - The type of parameters for the list operation */ abstract class Pager { protected hasNextPage: boolean; protected pageContext: { next: string | undefined; }; protected client: WatsonXAI; protected params: TParams; /** * Construct a Pager object. * * @param {WatsonXAI} client - The service client instance * @param {TParams} [params] - The parameters to be passed to the list operation * @throws {Error} If params.start is set (pagination should be handled internally) */ constructor(client: WatsonXAI, params?: TParams); /** * Returns true if there are potentially more results to be retrieved by invoking getNext(). * * @returns {boolean} True if there are more results available, false otherwise */ hasNext(): boolean; /** * Abstract method to fetch the next page of results. Must be implemented by concrete pager * classes. * * @abstract * @returns {Promise} A Promise that resolves to an array of resources * @throws {Error} If no more results are available */ abstract getNext(): Promise; /** * Returns all results by repeatedly invoking getNext() until all pages of results have been * retrieved. * * @returns {Promise} A Promise that resolves to an array of all resources */ getAll(): Promise; } /** FoundationModelSpecsPager can be used to simplify the use of listFoundationModelSpecs(). */ class FoundationModelSpecsPager extends Pager { /** * Construct a FoundationModelSpecsPager object. * * @param {WatsonXAI} client - The service client instance used to invoke * listFoundationModelSpecs() * @param {Object} [params] - The parameters to be passed to listFoundationModelSpecs() */ constructor(client: WatsonXAI, params?: WatsonXAI.ListFoundationModelSpecsParams); /** * Returns the next page of results by invoking listFoundationModelSpecs(). * * @returns {Promise} A Promise that resolves to an array of * foundation models */ getNext(): Promise; } /** FoundationModelTasksPager can be used to simplify the use of listFoundationModelTasks(). */ class FoundationModelTasksPager extends Pager { /** * Construct a FoundationModelTasksPager object. * * @param {WatsonXAI} client - The service client instance used to invoke * listFoundationModelTasks() * @param {Object} [params] - The parameters to be passed to listFoundationModelTasks() */ constructor(client: WatsonXAI, params?: WatsonXAI.ListFoundationModelTasksParams); /** * Returns the next page of results by invoking listFoundationModelTasks(). * * @returns {Promise} A Promise that resolves to an array of * foundation model tasks */ getNext(): Promise; } /** TextExtractionsPager can be used to simplify the use of listTextExtractions(). */ class TextExtractionsPager extends Pager { /** * Construct a TextExtractionsPager object. * * @param {WatsonXAI} client - The service client instance used to invoke listTextExtractions() * @param {Object} [params] - The parameters to be passed to listTextExtractions() */ constructor(client: WatsonXAI, params?: WatsonXAI.ListTextExtractionsParams); /** * Returns the next page of results by invoking listTextExtractions(). * * @returns {Promise} A Promise that resolves to an array of * text extraction resources */ getNext(): Promise; } /** TrainingsListPager can be used to simplify the use of listTrainings(). */ class TrainingsListPager extends Pager { /** * Construct a TrainingsListPager object. * * @param {WatsonXAI} client - The service client instance used to invoke listTrainings() * @param {Object} [params] - The parameters to be passed to listTrainings() */ constructor(client: WatsonXAI, params?: WatsonXAI.TrainingsListParams); /** * Returns the next page of results by invoking listTrainings(). * * @returns {Promise} A Promise that resolves to an array of * training resources */ getNext(): Promise; } /** FineTuningListPager can be used to simplify the use of fineTuningList(). */ class FineTuningListPager extends Pager { /** * Construct a FineTuningListPager object. * * @param {WatsonXAI} client - The service client instance used to invoke fineTuningList() * @param {Object} [params] - The parameters to be passed to fineTuningList() */ constructor(client: WatsonXAI, params?: WatsonXAI.FineTuningListParams); /** * Returns the next page of results by invoking fineTuningList(). * * @returns {Promise} A Promise that resolves to an array of * fine-tuning resources */ getNext(): Promise; } /** ModelsListPager can be used to simplify the use of modelsList(). */ class ModelsListPager extends Pager { /** * Construct a ModelsListPager object. * * @param {WatsonXAI} client - The service client instance used to invoke modelsList() * @param {Object} [params] - The parameters to be passed to modelsList() */ constructor(client: WatsonXAI, params?: WatsonXAI.ModelsListParams); /** * Returns the next page of results by invoking modelsList(). * * @returns {Promise} A Promise that resolves to an array of model * resources */ getNext(): Promise; } /** ListPromptsPager can be used to simplify the use of listPrompts(). */ class ListPromptsPager { protected hasNextPage: boolean; protected client: WatsonXAI; protected params: WatsonXAI.PromptListParams; /** * Construct a ListPromptsPager object. * * @class * @param {WatsonXAI} client - The service client instance used to invoke listPrompts() * @param {WatsonXAI.PromptListParams} [params] - The parameters to be passed to listPrompts() */ constructor(client: WatsonXAI, params: WatsonXAI.PromptListParams); /** * Returns true if there are potentially more results to be retrieved by invoking getNext(). * * @returns {boolean} True if there are more results available, false otherwise */ hasNext(): boolean; /** * Returns the next page of results by invoking listPrompts(). * * @returns {Promise} A Promise that resolves to an * array of catalog search response assets */ getNext(): Promise; /** * Returns all results by invoking listPrompts() repeatedly until all pages of results have been * retrieved. * * @returns {Promise} A Promise that resolves to an * array of catalog search response assets */ getAll(): Promise; } /** ListSpacesPager can be used to simplify the use of listSpaces(). */ class ListSpacesPager { protected hasNextPage: boolean; protected client: WatsonXAI; protected params: WatsonXAI.ListSpacesParams; /** * Construct a ListPromptsPager object. * * @class * @param {WatsonXAI} client - The service client instance used to invoke listPrompts() * @param {WatsonXAI.ListSpacesParams} [params] - The parameters to be passed to listPrompts() */ constructor(client: WatsonXAI, params?: WatsonXAI.PromptListParams); /** * Returns true if there are potentially more results to be retrieved by invoking getNext(). * * @returns {boolean} True if there are more results available, false otherwise */ hasNext(): boolean; /** * Returns the next page of results by invoking listSpaces(). * * @returns {Promise} A Promise that resolves to an array of space * resources */ getNext(): Promise; /** * Returns all results by invoking listPrompts() repeatedly until all pages of results have been * retrieved. * * @returns {Promise} A Promise that resolves to an array of space * resources */ getAll(): Promise; } /** TextClassificationsPager can be used to simplify the use of listTextClassifications(). */ class TextClassificationsPager extends Pager { /** * Construct a TextClassificationsPager object. * * @param {WatsonXAI} client - The service client instance used to invoke * listTextClassifications() * @param {Object} [params] - The parameters to be passed to listTextClassifications() */ constructor(client: WatsonXAI, params?: WatsonXAI.ListTextClassificationsParams); /** * Returns the next page of results by invoking listTextClassifications(). * * @returns {Promise} A Promise that resolves to an * array of text classification resources */ getNext(): Promise; } /** * CallbackHandler class to be used with callbacks provided by user in requests. Manages request * and response lifecycle callbacks for API operations. * * @class CallbackHandler */ class CallbackHandler { /** Callback function to be invoked before sending a request. */ requestCallback: InvokeRequestCallback | undefined; /** Callback function to be invoked after receiving a response. */ responseCallback: ReceiveResponseCallback | undefined; /** * Creates a new CallbackHandler instance. * * @param {RequestCallbacks} callbacks - Object containing request and response callback * functions */ constructor(callbacks: RequestCallbacks); /** * Handles the request callback by invoking it with sanitized parameters. Removes headers from * the parameters before passing to the callback. * * @param {RequestParameters} parameters - The request parameters to pass to the callback */ handleRequest(parameters: RequestParameters): void; /** * Handles the response callback by invoking it with the resolved response. Waits for the * response promise to resolve before invoking the callback. * * @template T - The type of the response * @param {Promise} response - The response promise to handle * @returns {Promise} A promise that resolves when the callback completes */ handleResponse(response: Promise): Promise; } } export { WatsonXAI }; export default WatsonXAI; export { TokenAuthenticationOptions, Certificates, Certificate, HttpsAgentMap, Response, Callback, } from "./base/index.mjs"; export type { Options, EmptyObject, JsonObject, ObjectStreamed, DefaultParams, CreateDeploymentParams, ListDeploymentsParams, DeploymentsGetParams, DeploymentsUpdateParams, DeploymentsDeleteParams, DeploymentsTextGenerationParams, DeploymentsTextGenerationStreamParams, DeploymentsTextChatParams, DeploymentsTextChatStreamParams, DeploymentsTimeSeriesForecastParams, ListFoundationModelSpecsParams, ListFoundationModelTasksParams, PostPromptParams, PostPromptConstants, GetPromptParams, CatalogSearch, PromptListParams, PatchPromptParams, PatchPromptConstants, DeletePromptParams, PutPromptLockParams, PutPromptLockConstants, GetPromptLockParams, GetPromptInputParams, PostPromptChatItemParams, PostPromptSessionParams, GetPromptSessionParams, PatchPromptSessionParams, DeletePromptSessionParams, PostPromptSessionEntryParams, PostPromptSessionEntryConstants, GetPromptSessionEntriesParams, PostPromptSessionEntryChatItemParams, PutPromptSessionLockParams, PutPromptSessionLockConstants, GetPromptSessionLockParams, GetPromptSessionEntryParams, DeletePromptSessionEntryParams, TextChatConstants, TextChatParams, TextChatStreamParams, TextChatStreamConstants, TextEmbeddingsParams, TextExtractionParams, ListTextExtractionsParams, TextExtractionGetParams, TextExtractionDeleteParams, TextGenerationParams, TextGenerationStreamParams, TextTokenizationParams, TrainingsCreateParams, TrainingsListParams, TrainingsListConstants, TrainingsGetParams, TrainingsDeleteParams, TextRerankParams, TimeSeriesForecastParams, CreateFineTuningParams, CreateFineTuningConstants, FineTuningListParams, GetFineTuningParams, DeleteFineTuningParams, CreateDocumentExtractionParams, ListDocumentExtractionsParams, GetDocumentExtractionParams, CancelDocumentExtractionsParams, CreateSyntheticDataGenerationParams, ListSyntheticDataGenerationsParams, GetSyntheticDataGenerationParams, CancelSyntheticDataGenerationParams, CreateTaxonomyParams, ListTaxonomiesParams, GetTaxonomyParams, DeleteTaxonomyParams, ModelsCreateParams, ModelsListParams, ModelsGetParams, ModelsUpdateParams, ModelsDeleteParams, GetUtilityAgentToolsParams, GetUtilityAgentToolParams, PostUtilityAgentToolsRunParams, PostUtilityAgentToolsRunByNameParams, ListSpacesParams, CreateSpaceParams, SpaceStorage, SpaceCompute, SpaceStage, SpaceSettings, SpaceMember, GetSpaceParams, DeleteSpaceParams, SpacePatchOperation, SpacePatchParams, TranscribeAudioParams, TextClassificationParams, ListTextClassificationsParams, TextClassificationGetParams, TextClassificationDeleteParams, ApiError, ApiErrorResponse, ApiErrorTarget, BaseModel, ConsumptionsLimit, DataConnection, CosDataConnection, CosDataLocation, DataConnectionReference, DataSchema, DeploymentEntity, DeploymentResource, DeploymentResourceCollection, DeploymentResourcePatch, DeploymentStatus, DeploymentSystem, DeploymentSystemDetails, DeploymentTextChatMessages, DeploymentTextGenProperties, DeploymentTSForecastParameters, Embedding, EmbeddingParameters, EmbeddingReturnOptions, EmbeddingsResponse, ExternalInformationExternalModel, ExternalInformationExternalPrompt, ExternalPromptAdditionalInformationItem, FoundationModel, FoundationModelLimits, FoundationModelTask, FoundationModelTasks, FoundationModelVersion, FoundationModels, GetPromptInputResponse, HardwareRequest, HardwareSpec, Inference, JsonPatchOperation, LifeCycleState, MaskProperties, Message, MetricsContext, ModelLimits, ModelRel, ModerationHapProperties, ModerationPiiProperties, ModerationProperties, ModerationResult, ModerationResults, ModerationTextRange, Moderations, ObjectLocation, OnlineDeployment, OnlineDeploymentParameters, PaginationFirst, PaginationNext, PromptModelParameters, PromptTuning, PromptTuningMetricsContext, PromptWithExternalModelParameters, Rel, RerankInput, RerankParameters, RerankResponse, RerankReturnOptions, RerankedResults, ResourceCommitInfo, ResourceMeta, ReturnOptionProperties, SimpleRel, Stats, SystemDetails, TaskBenchmark, TaskBenchmarkDataset, TaskBenchmarkMetric, TaskBenchmarkPrompt, TaskDescription, TaskRating, TextChatParameterTools, TextChatResponse, TextChatStreamResponse, TextChatResponseFormat, TextChatResultChoice, TextChatStreamResultChoice, TextChatResultMessage, TextChatResultDelta, TextChatResultChoiceStream, TextChatStreamItem, TextChatToolChoiceTool, TextChatToolFunction, TextChatUsage, TextExtractionDataReference, TextExtractionMetadata, TextExtractionResource, TextExtractionResourceEntity, TextExtractionResources, TextExtractionResponse, TextExtractionResults, ServiceError, TextExtractionStepOcr, TextExtractionStepTablesProcessing, TextExtractionSteps, TextGenLengthPenalty, TextGenParameters, TextGenResponse, TextGenResponseFieldsResultsItem, TextGenTokenInfo, TextGenTopTokenInfo, TextModeration, TextModerationWithoutThreshold, TextTokenizeParameters, TextTokenizeResponse, TextTokenizeResult, TSForecastInputSchema, TSForecastParameters, TSForecastResponse, TrainingAccumulatedSteps, TrainingBatchSize, TrainingInitMethod, TrainingInitText, TrainingLearningRate, TrainingMaxInputTokens, TrainingMaxOutputTokens, TrainingMetric, TrainingNumEpochs, TrainingNumVirtualTokens, TrainingParameters, TrainingResource, TrainingResourceCollection, TrainingResourceCollectionSystem, TrainingResourceEntity, TrainingStatus, TrainingTorchDtype, TrainingVerbalizer, Warning, WxPromptPatchModelVersion, WxPromptPostModelVersion, WxPromptResponseModelVersion, WxPromptSessionEntryListResultsItem, ChatItem, ExternalInformation, Prompt, PromptData, PromptLock, PromptWithExternal, UtilityAgentTool, WxPromptResponse, CatalogSearchResponseAsset, ListPromptsResponse, WxPromptSession, WxPromptSessionEntry, WxPromptSessionEntryList, WxUtilityAgentToolsResponse, WxUtilityAgentToolsRunRequest, WxUtilityAgentToolsRunResponse, TextChatMessagesTextChatMessageAssistant, TextChatMessagesTextChatMessageSystem, TextChatMessagesTextChatMessageTool, TextChatMessagesTextChatMessageUser, TextChatUserContentsTextChatUserImageURLContent, TextChatUserContentsTextChatUserTextContent, RequestParameters, RequestParametersWithoutHeaders, InvokeRequestCallback, ReceiveResponseCallback, RequestCallbacks, FineTuningEntity, FineTuningParameters, FineTuningPeftParameters, FineTuningResource, FineTuningResources, DocumentExtractionResource, DocumentExtractionResources, DocumentExtractionResponse, DocumentExtractionStatus, SyntheticDataGenerationContext, SyntheticDataGenerationDataReference, SyntheticDataGenerationLocations, SyntheticDataGenerationMetric, SyntheticDataGenerationMetrics, SyntheticDataGenerationResource, SyntheticDataGenerationResources, SyntheticDataGenerationResponse, SyntheticDataGenerationSample, SyntheticDataGenerationStatus, TaxonomyResource, TaxonomyResources, TaxonomyResponse, TaxonomyStatus, SoftwareSpecRel, TrainingDetails, DataInput, DataOutput, Metric, MetricTsMetrics, MetricTsadMetrics, DataPreprocessingTransformation, ModelResourceEntity, ModelResource, ModelEntityModelVersion, ModelEntitySchemas, ModelEntitySize, ContentInfo, ContentLocation, AudioTranscriptionResult, ModelResources, ModelDefinitionEntityPlatform, ModelDefinitionEntityRequestPlatform, ModelDefinitionEntity, ModelDefinitionId, ModelDefinitionRel, GPU, DocumentExtractionObjectLocation, ObjectLocationGithub, ErrorResponse, SpaceResource, SpaceResources, TextClassificationDataReference, TextClassificationParameters, TextClassificationResource, TextClassificationResourceEntity, TextClassificationResources, TextClassificationResponse, TextClassificationResults, TextClassificationSemanticConfig, TextExtractionSchema, TextExtractionSemanticKvpField, TextChatFunctionCall, TextChatToolCall, TextChatMessage, TextChatUserImageURL, TextChatUserContents, TextChatMessages, TextChatParameterFunction, } from "./types/index.mjs"; //# sourceMappingURL=vml_v1.d.mts.map