Recommendations - Intergraph Smart Reference Data - Help - Intergraph

Intergraph Smart Reference Data REST API (10.2)

Language
English
Product
Intergraph Smart Reference Data
Search by Category
Help
Smart Materials/Smart Reference Data Version
10.2

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

Notes

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

Sample request

https://<appserver with domain>/<virtual_directory>/Srd/V2/Projects('SDB')/Disciplines(5020)/Nls(1)/RecommendationRequests

{

"Port":443,

"Requests": [

{

"Attributes": ["FSW", "ASME B16.5", "ASTM A182 Grade F 316L (UNS S31603)"],

"NumberOfRecommendations": 4

}

]

}

Response

Element

Description

Type

Notes

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": [

"FSW",

"ASME B16.5",

"ASTM A182 Grade F 316L (UNS S31603)"

],

"NumberOfRecommendations": 4,

"Recommendations": [

{

"Index": 0,

"Confidence": 1

},

{

"Index": 88,

"Confidence": 1

},

{

"Index": 253,

"Confidence": 1

},

{

"Index": 254,

"Confidence": 1

}

]

}

]

}