{"id":151097,"date":"2023-09-11T16:23:51","date_gmt":"2023-09-11T07:23:51","guid":{"rendered":"https:\/\/support.questetra.com\/?p=151097"},"modified":"2026-03-30T17:48:24","modified_gmt":"2026-03-30T08:48:24","slug":"azure-openai-service-chat-interact-with-parameters","status":"publish","type":"post","link":"https:\/\/support.questetra.com\/en\/addons\/azure-openai-service-chat-interact-with-parameters\/","title":{"rendered":"Azure OpenAI Service #Chat: Interact with Parameters"},"content":{"rendered":"\n

Azure OpenAI Service #Chat: Interact with Parameters<\/strong><\/h4>\n\n\n\n

Azure OpenAI Service #Chat: \u30d1\u30e9\u30e1\u30fc\u30bf\u4ed8\u304d\u5bfe\u8a71<\/a><\/p>\n\n\n\n

Communicates with Azure OpenAI Service API (ChatGPT running on Microsoft infrastructure). Supports the assignment of advanced parameters. Specifically, sampling temperature, upper % sampling, recurrence prohibition, frequency prohibition and Logit bias can be set.<\/p>\n\n\n\n

\"Auto<\/figure>\n\n\n\n
\n
Configs for this Auto Step<\/summary>
\n
\n
AuthzConfU1<\/dt>
U1: HTTP_Authz Setting (Secret API Key as “Fixed Value”) *<\/span><\/dd>\n
StrConfU2<\/dt>
U2: Resource Name *<\/span>#{EL}<\/sup><\/span><\/dd>\n
StrConfU3<\/dt>
U3: Deply Id *<\/span>#{EL}<\/sup><\/span><\/dd>\n
StrConfU4<\/dt>
U4: API Version (default “2023-05-15”)#{EL}<\/sup><\/span><\/dd>\n
StrConfA0<\/dt>
A0: Responder Role (SYSTEM Role)#{EL}<\/sup><\/span><\/dd>\n
StrConfA1<\/dt>
A1: Request Message PROMPT *<\/span>#{EL}<\/sup><\/span><\/dd>\n
StrConfA2<\/dt>
A2: Set Parameters (Temp Top_P P-penalty F-penalty) in 4 lines#{EL}<\/sup><\/span><\/dd>\n
StrConfA3<\/dt>
A3: Set LogitBias (TokenID and Bias value pairs) for each line#{EL}<\/sup><\/span><\/dd>\n
StrConfA4<\/dt>
A4: Number of Responses (default 1)#{EL}<\/sup><\/span><\/dd>\n
StrConfA5<\/dt>
A5: Limit of Response Tokens (default 2048)#{EL}<\/sup><\/span><\/dd>\n
StrConfA6<\/dt>
A6: Set Stop Words (eg “.”)#{EL}<\/sup><\/span><\/dd>\n
StrConfB1<\/dt>
B1: Set FieldNames that store COMPLETION for each lines (update)#{EL}<\/sup><\/span><\/dd>\n
SelectConfB2<\/dt>
B2: STRING Data item to store Response JSON (update)<\/dd>\n
SelectConfC1<\/dt>
C1: NUMERIC Data item to store PROMPT Tokens (update)<\/dd>\n
SelectConfC2<\/dt>
C2: NUMERIC Data item to store COMPLETION Tokens (update)<\/dd>\n
SelectConfC3<\/dt>
C3: NUMERIC Data item to store Total Tokens (update)<\/dd>\n\n<\/dl>\n<\/div><\/details><\/div>\n<\/div>\n\n\n\n
\n
Script (click to open)<\/summary>
\n
\/\/ GraalJS Script (engine type: 3)\n\n\/\/\/\/\/\/\/\/ START "main()" \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\n\nmain();\nfunction main(){ \n\n\/\/\/\/\/\/ == Config Retrieving \/ \u5de5\u7a0b\u30b3\u30f3\u30d5\u30a3\u30b0\u306e\u53c2\u7167 ==\nconst strAuthzSetting = configs.get      ( "AuthzConfU1" );  \/\/\/ REQUIRED\n  engine.log( " AutomatedTask Config: Authz Setting: " + strAuthzSetting );\n\/*\nconst strModel        = configs.get( "StrConfM" ) !== "" ?   \/\/ NotRequired\n                        configs.get( "StrConfM" ) : "gpt-4"; \/\/ (default)\n  engine.log( " AutomatedTask Config: OpenAI Model: " + strModel );\n*\/\nconst strResourceName = configs.get( "StrConfU2" );\nconst strDeployId     = configs.get( "StrConfU3" );\nconst strAPIVersion   = configs.get( "StrConfU4" ) !== "" ?        \/\/ NotRequired\n                        configs.get( "StrConfU4" ) : "2023-05-15"; \/\/ (default)\n\nconst strSystemRole   = configs.get      ( "StrConfA0" );    \/\/ NotRequired\n\/*\nconst strLogPro1      = configs.get      ( "StrConfPro1" );  \/\/ NotRequired\nconst strLogCom1      = configs.get      ( "StrConfCom1" );  \/\/ NotRequired\nconst strLogPro2      = configs.get      ( "StrConfPro2" );  \/\/ NotRequired\nconst strLogCom2      = configs.get      ( "StrConfCom2" );  \/\/ NotRequired\nconst strLogPro3      = configs.get      ( "StrConfPro3" );  \/\/ NotRequired\nconst strLogCom3      = configs.get      ( "StrConfCom3" );  \/\/ NotRequired\n*\/\nconst strPrompt       = configs.get      ( "StrConfA1" );    \/\/\/ REQUIRED\n  if( strPrompt     === "" ){\n    throw new Error( "\\n AutomatedTask ConfigError:" +\n                     " Config {A1:Prompt} MUST NOT be empty \\n" );\n  }\n\nconst strParams       = configs.get      ( "StrConfA2" );    \/\/ NotRequired\nconst arrParams       = strParams !== "" ? strParams.split("\\n") : null;\nconst numTemperature  = isNaN(parseFloat(arrParams?.[0])) ? 1 : parseFloat( arrParams[0] );\nconst numTopP         = isNaN(parseFloat(arrParams?.[1])) ? 1 : parseFloat( arrParams[1] );\nconst numPresPenalty  = isNaN(parseFloat(arrParams?.[2])) ? 0 : parseFloat( arrParams[2] );\nconst numFreqPenalty  = isNaN(parseFloat(arrParams?.[3])) ? 0 : parseFloat( arrParams[3] );\n\/\/ const jsonLogitBias   = arrParams?.[4] ? JSON.stringify( arrParams[4] ) : null;\n  \/\/ Number(undefined)     \/\/ NaN\n  \/\/ Number(null)          \/\/ 0 \u2606\n  \/\/ Number('100a')        \/\/ NaN\n  \/\/ parseFloat(undefined) \/\/ NaN\n  \/\/ parseFloat(null)      \/\/ NaN\n\nconst strBias         = configs.get      ( "StrConfA3" );    \/\/ NotRequired\nconst arrBias         = strBias !== "" ? strBias.split("\\n") : null;\nconst strChoises      = configs.get      ( "StrConfA4" );    \/\/ NotRequired\nconst numChoises      = isNaN(parseInt(strChoises,10)) ? 1 : parseInt(strChoises,10);\nconst strLimit        = configs.get      ( "StrConfA5" );    \/\/ NotRequired\nconst numLimit        = isNaN(parseInt(strLimit,10)) ? 2048 : parseInt(strLimit,10);\nconst strStops        = configs.get      ( "StrConfA6" );    \/\/ NotRequired\nconst arrStops        = strStops !== "" ? strStops.split("\\n") : null;\nconst strQfields      = configs.get      ( "StrConfB1" );    \/\/ NotRequired\nconst arrQfields      = strQfields !== "" ? strQfields.split("\\n") : null;\n\nconst strPocketResponseJson     = configs.getObject( "SelectConfB2" ); \/\/ NotRequired\nconst numPocketPromptTokens     = configs.getObject( "SelectConfC1" ); \/\/ NotRequired\nconst numPocketCompletionTokens = configs.getObject( "SelectConfC2" ); \/\/ NotRequired\nconst numPocketTotalTokens      = configs.getObject( "SelectConfC3" ); \/\/ NotRequired\n\n\n\/\/\/\/\/\/ == Data Retrieving \/ \u30ef\u30fc\u30af\u30d5\u30ed\u30fc\u30c7\u30fc\u30bf\u306e\u53c2\u7167 ==\n\/\/ (Nothing. Retrieved via Expression Language in Config Retrieving)\n\n\n\/\/\/\/\/\/ == Calculating \/ \u6f14\u7b97 ==\n\n\/\/\/\/ OpenAI API > Documentation > API REFERENCE > CHAT\n\/\/\/\/ https:\/\/platform.openai.com\/docs\/api-reference\/chat\n\n\/\/\/ prepare json\nlet strJson = {};\n\/\/    strJson.model = strModel;\n    strJson.messages = [];\n    if ( strSystemRole !=="" ) {\n      let objSystemRole = {};\n          objSystemRole.role = "system";\n          objSystemRole.content = strSystemRole;\n      strJson.messages.push ( objSystemRole );\n    }\n\/*\n    if ( strLogPro1 !=="" && strLogCom1 !=="" ) {\n      let objLogPro = {};\n          objLogPro.role = "user";\n          objLogPro.content = strLogPro1;\n      strJson.messages.push ( objLogPro );\n      let objLogCom = {};\n          objLogCom.role = "assistant";\n          objLogCom.content = strLogCom1;\n      strJson.messages.push ( objLogCom );\n    }\n    if ( strLogPro2 !=="" && strLogCom2 !=="" ) {\n      let objLogPro = {};\n          objLogPro.role = "user";\n          objLogPro.content = strLogPro2;\n      strJson.messages.push ( objLogPro );\n      let objLogCom = {};\n          objLogCom.role = "assistant";\n          objLogCom.content = strLogCom2;\n      strJson.messages.push ( objLogCom );\n    }\n    if ( strLogPro3 !=="" && strLogCom3 !=="" ) {\n      let objLogPro = {};\n          objLogPro.role = "user";\n          objLogPro.content = strLogPro3;\n      strJson.messages.push ( objLogPro );\n      let objLogCom = {};\n          objLogCom.role = "assistant";\n          objLogCom.content = strLogCom3;\n      strJson.messages.push ( objLogCom );\n    }\n*\/\n\n    let objNewMsg = {};\n        objNewMsg.role = "user";\n        objNewMsg.content = strPrompt;\n    strJson.messages.push ( objNewMsg );\n\n    if ( arrParams?.[0] !=="" ) {\n      strJson.temperature       = numTemperature;\n    }\n    if ( arrParams?.[1] !=="" ) {\n      strJson.top_p             = numTopP;\n    }\n    if ( arrParams?.[2] !=="" ) {\n      strJson.presence_penalty  = numPresPenalty;\n    }\n    if ( arrParams?.[3] !=="" ) {\n      strJson.frequency_penalty = numFreqPenalty;\n    }\n\n    strJson.n          = numChoises;\n    strJson.max_tokens = numLimit;\n    strJson.user       = "m" + processInstance.getProcessModelInfoId().toString();\n    if ( arrStops !== null ){\n      strJson.stop = [];\n      for ( let i = 0; i < arrStops.length; i++ ){\n        if ( arrStops[i] === "- - -" ){\n          strJson.stop.push ( "\\n" );\n        }else{\n          strJson.stop.push ( arrStops[i] );\n        }\n      }\n    }\n    if ( arrBias !== null ){\n      strJson.logit_bias = {};\n      for ( let i = 0; i < arrBias.length; i++ ){\n        let arrNumParts = arrBias[i].match( \/-?\\d+\/g ); \/\/ numbers (including with minus signs)\n        if (arrNumParts.length >= 2) {\n          strJson.logit_bias[arrNumParts[0]] = Number(arrNumParts[1]);\n        }\n      }\n    }\n\n\/\/engine.log( JSON.stringify( strJson ) ); \/\/ debug\n\n\n\/\/\/ prepare request1\nlet request1Uri = "https:\/\/" + strResourceName + ".openai.azure.com\/openai\/deployments\/" + strDeployId + "\/chat\/completions?api-version=" + strAPIVersion;\nconst apiKey = httpClient.getOAuth2Token(strAuthzSetting);\n\nlet request1 = httpClient.begin(); \/\/ HttpRequestWrapper\n    request1 = request1.header("api-key", apiKey);\n    request1 = request1.body( JSON.stringify( strJson ), "application\/json" );\n\n\/\/\/ try request1\nconst response1     = request1.post( request1Uri ); \/\/ HttpResponseWrapper\n  engine.log( " AutomatedTask ApiRequest1 Start: " + request1Uri );\nconst response1Code = response1.getStatusCode() + ""; \/\/ JavaNum to string\nconst response1Body = response1.getResponseAsString();\n  engine.log( " AutomatedTask ApiResponse1 Status: " + response1Code );\n\nif( response1Code !== "200"){\n  throw new Error( "\\n AutomatedTask UnexpectedResponseError: " +\n                    response1Code + "\\n" + response1Body + "\\n" );\n}\n\n\n\/\/\/ parse response1\nconst response1Obj = JSON.parse( response1Body );\n\n\n\/\/\/\/\/\/ == Data Updating \/ \u30ef\u30fc\u30af\u30d5\u30ed\u30fc\u30c7\u30fc\u30bf\u3078\u306e\u4ee3\u5165 ==\n\nif( strPocketResponseJson !== null ){\n  engine.setData( strPocketResponseJson, response1Body );\n}\n\nif ( arrQfields !== null ) {\n  for ( let i = 0; i < response1Obj.choices.length; i++ ) {\n    if( engine.findDataDefinitionByVarName ( arrQfields?.[i] ) !== null ){\n      engine.setDataByVarName( arrQfields[i], \n                    response1Obj.choices[i].message.content ?? ""\n                  );\n    }\n  }\n}\n\nif( numPocketPromptTokens !== null ){\n  engine.setData( numPocketPromptTokens, new java.math.BigDecimal(\n                  response1Obj.usage.prompt_tokens ?? 0\n                ));\n}\nif( numPocketCompletionTokens !== null ){\n  engine.setData( numPocketCompletionTokens, new java.math.BigDecimal(\n                  response1Obj.usage.completion_tokens ?? 0\n                ));\n}\nif( numPocketTotalTokens !== null ){\n  engine.setData( numPocketTotalTokens, new java.math.BigDecimal(\n                  response1Obj.usage.total_tokens ?? 0\n                ));\n}\n\n\/\/ "??": Nullish coalescing operator (ES11)\n\/\/ https:\/\/developer.mozilla.org\/docs\/Web\/JavaScript\/Reference\/Operators\/Nullish_coalescing\n\n} \/\/\/\/\/\/\/\/ END "main()" \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\n\n<\/code><\/pre><\/div>\n<\/div><\/details><\/div>\n<\/div>\n\n\n\n
Download<\/span><\/h3>\n\n\n\n