@codesoul-co/hypha-inference / prompt

• Package index: @codesoul-co/hypha-inference
• Source: packages/inference/src/prompt.ts
• Exports: 4

Using this module

Use the Prompt module for using the public contracts and operations for this capability boundary. It exports 1 class, 3 functions.

Import from the package entrypoint

import {
  DefaultPromptCompiler,
  normalizePromptInput,
  normalizePromptInputFromInferenceRequest,
  renderMessages,
} from '@codesoul-co/hypha-inference';

Usage patterns

• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
• The module exposes 3 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.

Public exports

Symbol	Kind	Signature	Description
DefaultPromptCompiler	class	new DefaultPromptCompiler(): DefaultPromptCompiler	Default Prompt Compiler class with 2 public constructor or member entries; its exact declarations are listed below.
normalizePromptInput	function	normalizePromptInput(input: unknown): PromptMessage[]	Normalize Prompt Input function with 1 public call signature; parameters and return types are listed below.
normalizePromptInputFromInferenceRequest	function	normalizePromptInputFromInferenceRequest(request: InferenceRequest): PromptCompileInput	Normalize Prompt Input From Inference Request function with 1 public call signature; parameters and return types are listed below.
renderMessages	function	renderMessages(messages: PromptMessage[]): string	Render Messages function with 1 public call signature; parameters and return types are listed below.

DefaultPromptCompiler

Default Prompt Compiler class with 2 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultPromptCompiler } from '@codesoul-co/hypha-inference';
• Source module: prompt

Declaration

export declare class DefaultPromptCompiler implements PromptCompiler {
    compile<TInput = unknown>(input: PromptCompileInput<TInput>): Promise<CompiledPrompt>;
}

Public members

Member	Kind	Signature	Description
compile	method	compile<TInput = unknown>(input: PromptCompileInput<TInput>): Promise<CompiledPrompt>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(): DefaultPromptCompiler	Creates an instance of this class.

normalizePromptInput

Normalize Prompt Input function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { normalizePromptInput } from '@codesoul-co/hypha-inference';
• Source module: prompt

Declaration

export declare function normalizePromptInput(input: unknown): PromptMessage[];

Call signature

normalizePromptInput(input: unknown): PromptMessage[]

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: PromptMessage[]
• Description: The return contract is defined by the type shown above.

normalizePromptInputFromInferenceRequest

Normalize Prompt Input From Inference Request function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { normalizePromptInputFromInferenceRequest } from '@codesoul-co/hypha-inference';
• Source module: prompt

Declaration

export declare function normalizePromptInputFromInferenceRequest(request: InferenceRequest): PromptCompileInput;

Call signature

normalizePromptInputFromInferenceRequest(request: InferenceRequest): PromptCompileInput

Parameters

Parameter	Type	Required	Description
request	InferenceRequest<unknown>	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: PromptCompileInput<unknown>
• Description: The return contract is defined by the type shown above.

renderMessages

Render Messages function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { renderMessages } from '@codesoul-co/hypha-inference';
• Source module: prompt

Declaration

export declare function renderMessages(messages: PromptMessage[]): string;

Call signature

renderMessages(messages: PromptMessage[]): string

Parameters

Parameter	Type	Required	Description
messages	PromptMessage[]	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: string
• Description: The return contract is defined by the type shown above.