Skip to content

Chat GPT Speech To Text XML

This XML format represents a list audio files to be transcribed by ChatGPT, and the text that ChatGPT produces.

Tasks

Minimal XML Sample

The XML below represents the minimum information that needs to be provided to create a price list in SparkLayer.

<?xml version="1.0"?>
<Transcriptions>
  <Transcription>
    <File>C:\Users\admin\Downloads\sample_dialog.mp3</File>
  </Transcription>
</Transcriptions>

Transcriptions

The Transcriptions element is the root of the XML document, and represents a list of files for ChatGPT to transcribe, and a common set of options to apply to all of them.

XML Field  Example  Field Type  Input  Description
Options See below Element Optional Common options to apply to all chats.
Transcription See below Collection Required A collection of one or more Transcription elements. 
<?xml version="1.0"?>
<Transcriptions>
  <Options /> <!-- See below -->
  <Transcription /> <!-- See below -->
</Transcriptions>

Transcription

The Transcription element represents an individual chat session, which requires a response from ChatGPT. This element appears as a child of the root Transcriptions element. The ChatCompletion element can appear one or more times.

XML Field  Example  Field Type  Input  Description
@Id 1 string Optional Used to provide an identifier for this transcription.
Options See below Element Optional Options to apply to this specific transcription alone.
File C:\Users\admin\Downloads\sample_dialog.mp3 string Required The audio file to transcribe. The following formats are supported: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, webm
Text I would like to find out... string Read Only The collection of Response elements produced by ChatGPT. 
<?xml version="1.0"?>
<Transcriptions>
  <Transcription Id="1">
    <Options /> <!-- See below -->
    <File>C:\Users\admin\Downloads\sample_dialog.mp3</File>
    <Text>I would like to find out if Zynk would be a good solution for my business. We are interested in integrating our e-commerce platform with Sage. Can you advise what tasks can be automated, such as entering our web orders into Sage?</Text>
  </Transcription>
</Transcriptions>

Options

The Options element represents a set of options ChatGPT should to apply when generating it's response. This element can appear as a child of both the Transcriptions and Transcription element. When it is present at both levels, the options specified at the Transcription will take precedence.

XML Field  Example  Field Type  Input  Description
@Language en string Optional A unique identifier representing your end-user, which helps OpenAI to monitor and detect abuse, and provide more actionable feedback in the event of any policy violations. It is recommended to hash usernames or email addresses, in order to avoid sending any personally identifiable information.
@Model gpt-3.5-turbo string Optional Enter the ID of the model to use to generate the response. Please refer to the model endpoint compatibility table for details on which models work with the Transcription API.
@Prompt The transcript is about Zynk... string Optional An optional text to guide the model's style.
@Temperature 1 float Optional The sampling temperature to use, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. 
<Options Language="en" Model="gpt-3.5-turbo" Prompt="The transcript is about Zynk, a piece of software used to automate business processes." Temperature="1" />

Complete XML Sample

This sample shows all data that can be provided via our price list XML format.

<?xml version="1.0"?>
<Transcriptions>
  <Options Language="en" Model="gpt-3.5-turbo" Prompt="The transcript is about Zynk, a piece of software used to automate business processes." Temperature="1" />
  <Transcription Id="1">
    <Options Language="en" Model="gpt-3.5-turbo" Prompt="The transcript is about Zynk, a piece of software used to automate business processes." Temperature="1" />
    <File>C:\Users\admin\Downloads\sample_dialog.mp3</File>
    <Text>I would like to find out if Zynk would be a good solution for my business. We are interested in integrating our e-commerce platform with Sage. Can you advise what tasks can be automated, such as entering our web orders into Sage?</Text>
  </Transcription>
</Transcriptions>