Test

<back to all web services

SpeechToText

AI

Convert speech to text

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


/** @description Output object for generated text */
class TextOutput implements JsonSerializable
{
    public function __construct(
        /** @description The generated text */
        // @ApiMember(Description="The generated text")
        /** @var string|null */
        public ?string $text=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['text'])) $this->text = $o['text'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->text)) $o['text'] = $this->text;
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Response object for text generation requests */
// @Api(Description="Response object for text generation requests")
class TextGenerationResponse implements JsonSerializable
{
    public function __construct(
        /** @description List of generated text outputs */
        // @ApiMember(Description="List of generated text outputs")
        /** @var array<TextOutput>|null */
        public ?array $results=null,

        /** @description Detailed response status information */
        // @ApiMember(Description="Detailed response status information")
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['results'])) $this->results = JsonConverters::fromArray('TextOutput', $o['results']);
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->results)) $o['results'] = JsonConverters::toArray('TextOutput', $this->results);
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

/** @description Convert speech to text */
// @Api(Description="Convert speech to text")
class SpeechToText implements IGeneration, JsonSerializable
{
    public function __construct(
        /** @description The audio stream containing the speech to be transcribed */
        // @ApiMember(Description="The audio stream containing the speech to be transcribed")
        // @Required()
        /** @var string */
        public string $audio='',

        /** @description Optional client-provided identifier for the request */
        // @ApiMember(Description="Optional client-provided identifier for the request")
        /** @var string|null */
        public ?string $refId=null,

        /** @description Tag to identify the request */
        // @ApiMember(Description="Tag to identify the request")
        /** @var string|null */
        public ?string $tag=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['audio'])) $this->audio = $o['audio'];
        if (isset($o['refId'])) $this->refId = $o['refId'];
        if (isset($o['tag'])) $this->tag = $o['tag'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->audio)) $o['audio'] = $this->audio;
        if (isset($this->refId)) $o['refId'] = $this->refId;
        if (isset($this->tag)) $o['tag'] = $this->tag;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SpeechToText DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/SpeechToText HTTP/1.1 
Host: test.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	audio: String,
	refId: String,
	tag: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	results: 
	[
		{
			text: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}