Skip to main content

Get processing session information​

Get processing session information

Path Parameters
  • processingId string required
Responses

processing object

Schema
  • processingId string
  • status string

    Status of the processing. One of "Processing", "Done", "Error".

  • sessionType string

    Type of the session specified when creating the session.

  • results object

    Processing results. Values are populated as they are produced.

  • transcript object

    Transcript of the recorded session. Value becomes available during session processing.

  • utterances object[]

    List of all utterances.

  • Array [
  • text string required

    Text of the utterance.

  • start integer required

    Relative start time in milliseconds of this utterance in the recording.

  • end integer required

    Relative end time in milliseconds of this utterance in the recording.

  • speaker string required

    Speaker of the utterance. Speakers are labeled with letters, starting with 'A'.

  • words object[] required

    List of words in the utterance.

  • Array [
  • text string required

    text of the single word

  • start integer required

    Relative start time [ms] of this word occurrence in the recording

  • end integer required

    Relative end time [ms] of this word occurrence in the recording

  • ]
  • ]
  • speakerMapping object

    Mapping of transcript speaker labels to Upheal user identifiers. Each key is a speaker label as it appears in the utterances (e.g. "A", "B") and each value is the UUID of the user that speaker is mapped to. One user identifier can be assigned to multiple speakers.

  • property name* string
  • summaries object[]

    Deprecated - replaced by topics.

  • Array [
  • summaryType string

    type of generated summary, one of "conversation", "sum_of_sum"

  • text string
  • ]
  • recording object
  • durationMs integer

    Length of the recording in milliseconds

  • namedEntities object[]
  • Array [
  • entityType string required

    Type of detected entity. E.g. of "medical_condition", "organisation", "location", "person_name"

  • name string required
  • summary string

    Summarized description of the entity

  • ]
  • progressNotes object[]

    List of progress notes. Each note has a category and text.

  • Array [
  • category string required

    Progress note category. For example "ClientPresentation", "TherapeuticIntervention", "Plan",...

  • categoryName string

    Human readable name for progress note category.

  • text string required

    Progress note text.

  • formatting object
  • nestingLevel integer

    Nesting level of the note in a context of all notes in its category. Notes with leve > 0 can be considered as a bulleted list items.

  • ]
  • topics object[]
  • Array [
  • headline string required

    Topic headline

  • gist string required
  • start integer required

    Relative start time [ms] of this topic in the recording.

  • end integer required

    Relative end time [ms] of this topic in the recording.

  • ]
  • errors object[]

    List of errors that occurred during processing.

  • Array [
  • errorMessage string required
  • errorCode string required

    Error code identifying the problem. See Error codes.

  • fatal boolean required
  • ]
Loading...