Interface IAICompanion

Defines the contract for an AI Companion translation provider

Namespace: Sdl.LanguagePlatform.TranslationMemoryApi.AICompanion

Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll

Syntax

public interface IAICompanion

Remarks

This interface exposes AI Companion settings, asynchronous search capabilities, and a method to display a settings dialog.

Properties

Name

Gets or sets the name of the AI Companion.

Declaration

string Name { get; set; }

Property Value

Type	Description
String

Settings

Gets the current AI Companion settings, including selected prompt, connection, and available options.

Declaration

AISettings Settings { get; }

Property Value

Type	Description
AISettings

Methods

DisplaySettingsControl(IWin32Window, AISettingsDialogParams)

Displays the AI Companion settings dialog.

Declaration

bool DisplaySettingsControl(IWin32Window owner, AISettingsDialogParams dialogParams)

Parameters

Type	Name	Description
IWin32Window	owner	The window that owns the dialog.
AISettingsDialogParams	dialogParams	The dialog parameters, including selected prompt and connection.

Returns

Type	Description
Boolean	True if settings were changed and require a refresh; otherwise, false.

SearchAsync(AISearchParams)

Performs an asynchronous AI search using the specified parameters.

Declaration

Task<AISearchResult> SearchAsync(AISearchParams searchParams)

Parameters

Type	Name	Description
AISearchParams	searchParams	The parameters for the AI search, including prompt, connection, and segment context.

Returns

Type	Description
Task<AISearchResult>	A task that represents the asynchronous operation, containing the AI search result.