openai plugin - Insctance in Results

[Gabriel Guzmán]

I hope this message finds you well. I am writing to seek your assistance with an issue encountered while using the openaibs plugin in our production environment.

Context:

After successfully installing and testing the plugin using the client and scenario outlined in the installation guide, I am unable to retrieve the <instance> field in XML format within the response. Currently, this field returns data as JSON (as shown below), despite configuring the result format to standard in umsopenaibs.xml.

Example Response Snippet:

xml

<?xml version="1.0"?><result><interpretation grammar="builtin:speech/transcribe" confidence="1">

<instance>{&quot;type&quot;:&quot;response.done&quot;,&quot;event_id&quot;:&quot;event_BmMRyW8W9bbm1SSEnBP6q&quot;,&quot;response&quot;:{&quot;id&quot;:&quot;resp_BmMRvXOvtPpKffz8l9xOd&quot;,&quot;object&quot;:&quot;realtime.response&quot;,&quot;status&quot;:&quot;completed&quot;,&quot;status_details&quot;:{},&quot;output&quot;:[{&quot;id&quot;:&quot;item_BmMRvglCX2qaWHWP77w0J&quot;,&quot;type&quot;:&quot;message&quot;,&quot;object&quot;:&quot;realtime.item&quot;,&quot;status&quot;:&quot;completed&quot;,&quot;role&quot;:&quot;assistant&quot;,&quot;content&quot;:[{&quot;type&quot;:&quot;uri&quot;,&quot;audio&quot;:&quot;file://umsopenaibs-05641019b6c64046-1-0-0-8-kHz.wav&quot;,&quot;transcript&quot;:&quot;Si necesitas reservar una habitación, te recomiendo comunicarte con el hotel donde deseas alojarte. Si necesitas ayuda para encontrar un hotel o tienes alguna otra consulta, estaré encantado de asistirte.&quot;}]}],&quot;usage&quot;:{},&quot;conversation_id&quot;:&quot;conv_BmMRuzFmJLXc6aBnAuuJa&quot;,&quot;voice&quot;:&quot;alloy&quot;,&quot;modalities&quot;:[&quot;text&quot;,&quot;audio&quot;],&quot;output_audio_format&quot;:&quot;pcm16&quot;,&quot;temperature&quot;:0.6000000238418579,&quot;max_output_tokens&quot;:&quot;inf&quot;}}</instance>

<input mode="speech">Book a room.</input></interpretation></result>

- Steps Taken to Resolve:

Set result to standard (default) in umsopenaibs.xml, expecting application/x-nlsml with XML-formatted <instance>.

- Added tag-format="swi-semantics/xml" to both conf/umsopenaibs.xml and data/grammar.xml (no change observed).

- Modified the grammar URI to data/speechtranscribe.txt include tag-format:

builtin:speech/transcribe?tag-format=semantics/xml

Documentation Reference:

Per the NLSML format documentation, setting tag-format to semantics/xml or swi-semantics/xml should force the <instance> field to render as XML. However, all attempts result in JSON.

Could you please clarify:

What specific configuration change is required to ensure the <instance> field returns XML instead of JSON?

Are there dependencies or additional parameters needed beyond the steps outlined?

We appreciate your urgent attention to this matter, as it impacts our integration workflow. Thank you for your support!

Best regards,

[Vahagn Kocharyan]

Hi . You need to leave it as defaults using "standard" for xml.

<!-- Recognition Results Configuration
   Attributes:
   *  format
      This parameter specifies the format of results to be returned to the client (use "standard" for NLSML and "json" for JSON).
   *  indent
      This parameter specifies the indent to use while composing the results.
   *  confidence-format
      This parameter specifies the format of the confidence score to be returned (use "auto" for a format based on protocol version, "mrcpv2" for a float value in the range of 0..1, "mrcpv1" for an integer value in the range of 0..100).
   Elements:
   *  none
   -->
   <results
      format="standard"
      indent="0"
      confidence-format="auto"
   />