Headers
|
Header Name |
Description |
Required |
Values |
|---|---|---|---|
|
Authorization |
Access token |
Required |
Bearer <access_token> |
|
Content-Type |
Request type format |
Required |
application/json |
POST body
|
Element |
Description |
Type |
Required |
|---|---|---|---|
|
Port |
Port on which Inference Service is running |
Integer |
Required |
|
Attributes |
Attributes of commodity code/codelist short description/description |
String Collection |
Required |
|
NumberOfRecommendations |
Number of recommendations |
String |
|
|
SourceAnnotation |
Attribute for commodity code source hierarchy |
String Collection |
Optional |
Sample request
https://<appserver with domain>/<virtual_directory>/Srd/V2/ Projects('SDB')/Disciplines(5020)/Nls(1)/RecommendationRequests
{
"Debug": "False",
"Port":2492,
"Requests": [
{
"Attributes": ["Elbolet®", "CL3000", "Bonney Forge", "A105"],
"NumberOfRecommendations": 5,
"SourceAnnotation" :["Branch Fittings","Elbolets®","EOLLR"]
}
]
}
Response
|
Element |
Description |
Type |
Notes |
|---|---|---|---|
|
Attributes |
Attributes of commodity code/codelist short description/description |
String Collection |
|
|
NumberOfRecommendations |
Number of recommendations |
String |
|
|
SourceAnnotation |
Attribute for commodity code source hierarchy |
String Collection |
|
|
Index |
Index of recommended short desc/description record |
Integer |
|
|
Confidence |
This score indicates the confidence that the answer is the right match for the given user query |
Integer |
The confidence score is a number between 0 and 1. A score of 1 is likely an exact match, while a score of 0 means, that no matching record was found |
Sample Response
{
"Responses": [
{
"Attributes": [
"Elbolet®",
"CL3000",
"Bonney Forge",
"A105"
],
"NumberOfRecommendations": 5,
"SourceAnnotation": [
"Branch Fittings",
"Elbolets®",
"EOLLR"
],
"Recommendations": [
{
"Index": 15626,
"Confidence": 0.8
},
{
"Index": 12106,
"Confidence": 0.8
},
{
"Index": 11912,
"Confidence": 0.8
},
{
"Index": 14706,
"Confidence": 0.6
},
{
"Index": 14106,
"Confidence": 0.6
}
],
"Debug": null
}
]
}