Recognise Audio | Machani Robotics SDK

curl -X POST https://api.machanirobotics.com/v1/conversation/audio/recognise:recogniseAudio \
     -H "Content-Type: application/json" \
     -d '{
  "audio": {
    "service": 2,
    "languageTag": {
      "countryTag": 840,
      "languageTag": 1033
    }
  }
}'

{
  "audioState": 3,
  "audio": {
    "service": 2,
    "languageTag": {
      "countryTag": 840,
      "languageTag": 1033,
      "inputAudio": "audio/wav",
      "inputText": "Hello, how can I assist you today?",
      "inputSpeech": "Hello, how can I assist you today?",
      "inputNone": false,
      "outputAudio": "audio/wav",
      "outputText": "Hello, how can I assist you today?",
      "outputSpeech": "Hello, how can I assist you today?",
      "outputNone": false
    },
    "name": "meeting_recording_20240615",
    "audioData": "UklGRiQAAABXQVZFZm10IBAAAAABAAEAQB8AAIA+AAACABAAZGF0YQAAAAA=",
    "uploadPath": "s3://machani-audio-uploads/meeting_recording_20240615.wav",
    "livePipelineFilePath": "/tmp/transcribe.wav",
    "vadThreshold": 0.5,
    "sampleRate": 16000,
    "wordwiseTimestamps": [
      {
        "word": "Hello",
        "start": "0.00s",
        "end": "0.50s",
        "probability": 0.98
      },
      {
        "word": "how",
        "start": "0.51s",
        "end": "0.70s",
        "probability": 0.95
      },
      {
        "word": "can",
        "start": "0.71s",
        "end": "0.85s",
        "probability": 0.96
      },
      {
        "word": "I",
        "start": "0.86s",
        "end": "0.90s",
        "probability": 0.97
      },
      {
        "word": "assist",
        "start": "0.91s",
        "end": "1.20s",
        "probability": 0.99
      },
      {
        "word": "you",
        "start": "1.21s",
        "end": "1.40s",
        "probability": 0.98
      },
      {
        "word": "today",
        "start": "1.41s",
        "end": "1.80s",
        "probability": 0.97
      }
    ]
  },
  "message": {
    "id": "msg-20240615-001",
    "role": 2,
    "text": {
      "content": [
        "Hello, how can I assist you today?"
      ]
    },
    "image": {
      "id": "img-20240615-001",
      "uris": [
        "https://cdn.machanirobotics.com/images/assistant_response_20240615.png"
      ],
      "b64Json": [
        "iVBORw0KGgoAAAANSUhEUgAAAAUA"
      ],
      "savedPaths": [
        "/var/data/images/assistant_response_20240615.png"
      ]
    },
    "vision": {
      "id": "vision-20240615-001",
      "description": "Image contains a robot assistant icon and a speech bubble.",
      "objects": [
        {
          "object": "robot",
          "confidence": 0.92,
          "boundingBox": {
            "x": 15,
            "y": 20,
            "width": 100,
            "height": 150
          }
        },
        {
          "object": "speech bubble",
          "confidence": 0.88,
          "boundingBox": {
            "x": 120,
            "y": 30,
            "width": 200,
            "height": 100
          }
        }
      ]
    },
    "options": {
      "service": 2,
      "model": "whisper-large-v2",
      "languageTag": {
        "countryTag": 840,
        "languageTag": 1033,
        "inputAudio": "audio/wav",
        "inputText": "Hello, how can I assist you today?",
        "inputSpeech": "Hello, how can I assist you today?",
        "inputNone": false,
        "outputAudio": "audio/wav",
        "outputText": "Hello, how can I assist you today?",
        "outputSpeech": "Hello, how can I assist you today?",
        "outputNone": false
      }
    }
  }
}

RecogniseAudio processes the provided audio data to perform speech recognition.

This RPC accepts a RecogniseAudioRequest containing raw audio input and returns a RecogniseAudioResponse. The response includes the transcribed text, the state of the audio processing session, and any associated metadata.

HTTP Mapping: POST “/v1/conversation/audio/recognise” The entire request body is forwarded to the service.

RecogniseAudio processes the provided audio data to perform speech recognition. This RPC accepts a RecogniseAudioRequest containing raw audio input and returns a RecogniseAudioResponse. The response includes the transcribed text, the state of the audio processing session, and any associated metadata. HTTP Mapping: POST "/v1/conversation/audio/recognise" The entire request body is forwarded to the service.

Request

This endpoint expects an object.

audioobjectRequired

Audio data and associated metadata for the recognition request.

Response

audioStateintegerRead-only

The current state of the audio processing session. Indicates relevant status information of the ongoing or completed audio processing.

audioobject

Audio data and associated metadata included in the response.

messageobject

Covnersation Message containing the transcribed text from the audio.

Errors

400

Bad Request Error