The modelobjects_search tool finds the Model Objects that can answer a question. You can filter the Model Objects by their Model Class and by their name or label. For each Model Object, the tool returns its status, the evaluations that its Model Class offers, and a link that opens the Model Object in Pricefx. An evaluation is a calculation that a Model Class defines to return results from a Model Object, for example a price recommendation. To run an evaluation, use the Model Objects Evaluate tool.
Tool Name – modelobjects_search
Title – Model Objects Search
Type – Private
Access Profile – Operator
Permissions
The tool is available to the Operator access profile when tool access control is on. The modelobjects_search tool uses your Pricefx permissions. You need read access to Model Objects. The tool returns only the Model Objects that your user groups are allowed to view, at both the Model Object level and the Model Class level.
Parameters
|
Parameter |
Required |
Description |
|---|---|---|
|
|
No |
Text that the unique name of the Model Class contains. The comparison ignores case. For example, negotiation finds the Model Classes Negotiation_Guidance_2 and VMA_Negotiation_Guidance_2. Default: Empty, which searches the Model Objects of every Model Class. |
|
|
No |
Text that the unique name or the label of the Model Object contains, for example France. The comparison ignores case. Default: Empty, which applies no filter. |
|
|
No |
Maximum number of Model Objects to return, from 1 to 20. Default: 5. |
Output
The modelobjects_search tool returns an object with the following fields.
|
Field |
Description |
|---|---|
|
|
The matching Model Objects. Each Model Object has the fields in the Model Object Fields table on this page. |
|
|
true when more Model Objects match the search than the tool returned. To see them, narrow the search or increase |
Model Object Fields
|
Field |
Description |
|---|---|
|
|
The typed ID of the Model Object, for example 42.MO. Use this value in the |
|
|
The unique name of the Model Object. |
|
|
The label of the Model Object. The field is absent when the Model Object has no label. |
|
|
The unique name of the Model Class that the Model Object is based on. |
|
|
The names of the evaluations that the Model Class offers. Use one of these names in the |
|
|
The date and time when the Model Object was last updated. |
|
|
The status of the Model Object. The values are described in the Model Object Status Values table on this page. |
|
|
The calculation step from which the |
|
|
A link that opens the Model Object in Pricefx. |
Model Object Status Values
|
Status |
Description |
|---|---|
|
READY |
The Model Object is calculated up to the last step of its Model Class. No step failed and no step is still calculating. |
|
DRAFT |
The Model Object is calculated up to its current step only. Later steps are not calculated. |
|
CALCULATING |
The current step of the Model Object is still calculating. |
|
ERROR |
The calculation of the current step of the Model Object failed. |
|
INVALID |
The Model Object cannot be evaluated, for example because its Model Class is not found. |
Behavior and Limitations
-
The
modelobjects_searchtool lists Model Objects in this order of status: READY, DRAFT, CALCULATING, ERROR, INVALID. Within each status, the most recently updated Model Object comes first. -
The
modelobjects_searchtool filters and sorts only. The AI assistant chooses which Model Class answers your question, based on the question and the knowledge base. -
The
modelobjects_searchtool works with every Model Class, for example Negotiation Guidance. The evaluations come from the Model Class definition. -
The
modelobjects_searchtool returns at most 20 Model Objects per call. -
A Model Object with a status other than READY can still be evaluated up to the last calculated step. The
evaluationStepfield shows that step. -
The
modelobjects_searchtool leaves out a Model Object whose data it cannot read, and returns the other Model Objects. -
On a partition with MCP Commons, the
modelobjects_searchtool replaces the Groovy tool of the same name.
Errors
|
Situation |
Error Message |
|---|---|
|
|
|
|
|
|
|
Pricefx rejects the request |
|