0 / 0
Decision Optimization solve parameters

Solve parameters

To control solve behavior, you can specify Decision Optimization solve parameters in your request as named value pairs.

For example:
"solve_parameters" : {
You can use this code to collect the engine log tail during the solve and the whole engine log as output at the end of the solve.

You can use these parameters in your request.

Name Type Description
oaas.timeLimit Number You can use this parameter to set a time limit in milliseconds.
oaas.resultsFormat Enum
  • JSON
  • CSV
  • XML
  • TEXT
  • XLSX
Specifies the format for returned results. The default formats are as follows:
  • CPLEX - .xml
  • CPO - .json
  • OPL - .csv
  • DOcplex - .json
Other formats might or might not be supported depending on the application type.
oaas.oplRunConfig String Specifies the name of the OPL run configuration to be executed.
oaas.docplex.python 3.10

You can use this parameter to set the Python version for the run in your deployed model. If not specified, 3.10 is used by default.

oaas.logTailEnabled Boolean Use this parameter to include the log tail in the solve status.
oaas.logAttachmentName String If defined, engine logs will be defined as a job output attachment.
oaas.engineLogLevel Enum
  • OFF
  • INFO
  • FINE
You can use this parameter to define the level of detail that is provided by the engine log. The default value is INFO.
oaas.logLimit Number Maximum log-size limit in number of characters.
oaas.dumpZipName Can be viewed as Boolean (see Description) If defined, a job dump (inputs and outputs) .zip file is provided with this name as a job output attachment. The name can contain a placeholder ${job_id}. If defined with no value, dump_${job_id}.zip attachmentName is used. If not defined, by default, no job dump .zip file is attached.
oaas.dumpZipRules String If defined, ta .zip file is generated according to specific job rules (RFC 1960-based Filter). It must be used in conjunction with the {@link DUMP_ZIP_NAME} parameter. Filters can be defined on the duration and the following {@link com.ibm.optim.executionservice.model.solve.SolveState} properties:
  • duration
  • solveState.executionStatus
  • solveState.interruptionStatus
  • solveState.solveStatus
  • solveState.failureInfo.type
 or (&(duration<1000)(!(solveState.solveStatus=OPTIMAL_SOLUTION)))
 or (|(solveState.interruptionStatus=OUT_OF_MEMORY)
 or (&(duration<1000)(!(solveState.solveStatus=OPTIMAL_SOLUTION)))
 or (|(solveState.interruptionStatus=OUT_OF_MEMORY)
oaas.outputUploadPeriod Number Intermediate output in minutes. This parameter can be used to set up intermediate output publication (if any).
oaas.outputUploadFiles String (RegExp) RegExp filter for files to be included in the output upload. If nothing is defined, all outputs are added.
Generative AI search and answer
These answers are generated by a large language model in watsonx.ai based on content from the product documentation. Learn more