Interface ITranslatorService

Provides text translation capabilities. Source and target languages are declared via Settings and passed at session creation.

Inherited Members

IDisposable.Dispose()

Namespace: Zaya.Translator.Services

Assembly: Zaya.Translator.dll

Syntax

public interface ITranslatorService : IDisposable

Properties

Description

Gets the UI description for this engine (localized).

Declaration

LocalizedString Description { get; }

Property Value

Type	Description
LocalizedString

DisplayName

Gets the UI display name for this engine (localized).

Declaration

LocalizedString DisplayName { get; }

Property Value

Type	Description
LocalizedString

EngineId

Gets a unique identifier for this translation engine (e.g., "azure-ai", "google"). Used for profile serialization and engine lookup.

Declaration

string EngineId { get; }

Property Value

Type	Description
string

IsAvailable

Gets whether this translation engine is available on the current system.

Declaration

bool IsAvailable { get; }

Property Value

Type	Description
bool

Settings

Gets the list of engine-specific settings that can be configured via UI.

Declaration

IReadOnlyList<SettingDescriptor> Settings { get; }

Property Value

Type	Description
IReadOnlyList<SettingDescriptor>

Methods

CreateSessionAsync(IReadOnlyDictionary<string, object>, CancellationToken)

Creates a new translation session with the specified engine settings.

Declaration

Task<ITranslatorSession> CreateSessionAsync(IReadOnlyDictionary<string, object> engineSettings, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IReadOnlyDictionary<string, object>	engineSettings	Engine-specific settings dictionary.
CancellationToken	cancellationToken	Token to cancel session creation.

Returns

Type	Description
Task<ITranslatorSession>	An active translation session ready to translate text.

CreateSessionAsync(CancellationToken)

Creates a new translation session with the default engine settings.

Declaration

Task<ITranslatorSession> CreateSessionAsync(CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	Token to cancel session creation.

Returns

Type	Description
Task<ITranslatorSession>	An active translation session ready to translate text.