AxPromptTemplate
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/prompt.ts#L42
Constructors
Constructor
new AxPromptTemplate(
sig: Readonly<AxSignature>,
options?: Readonly<AxPromptTemplateOptions>,
fieldTemplates?: Record<string, AxFieldTemplateFn>): AxPromptTemplate;
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/prompt.ts#L49
Parameters
Parameter | Type |
---|---|
sig | Readonly <AxSignature > |
options? | Readonly <AxPromptTemplateOptions > |
fieldTemplates? | Record <string , AxFieldTemplateFn > |
Returns
AxPromptTemplate
Methods
render()
render<T>(values: T | readonly AxMessage<T>[], __namedParameters: Readonly<{
demos?: Record<string, AxFieldValue>[];
examples?: Record<string, AxFieldValue>[];
skipSystemPrompt?: boolean;
}>): (
| {
cache?: boolean;
content: string;
role: "system";
}
| {
content: | string
| (
| {
cache?: boolean;
text: string;
type: "text";
}
| {
altText?: string;
cache?: boolean;
details?: "high" | "low" | "auto";
image: string;
mimeType: string;
optimize?: "auto" | "quality" | "size";
type: "image";
}
| {
cache?: boolean;
data: string;
duration?: number;
format?: "wav" | "mp3" | "ogg";
transcription?: string;
type: "audio";
}
| {
cache?: boolean;
data: string;
extractedText?: string;
filename: string;
mimeType: string;
type: "file";
}
| {
cache?: boolean;
cachedContent?: string;
description?: string;
title?: string;
type: "url";
url: string;
})[];
name?: string;
role: "user";
}
| {
cache?: boolean;
content?: string;
functionCalls?: object[];
name?: string;
role: "assistant";
})[];
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/prompt.ts#L122
Type Parameters
Type Parameter | Default type |
---|---|
T | any |
Parameters
Parameter | Type |
---|---|
values | T | readonly AxMessage <T >[] |
__namedParameters | Readonly <{ demos? : Record <string , AxFieldValue >[]; examples? : Record <string , AxFieldValue >[]; skipSystemPrompt? : boolean ; }> |
Returns
(
| {
cache?
: boolean
;
content
: string
;
role
: "system"
;
}
| {
content
: | string
| (
| {
cache?
: boolean
;
text
: string
;
type
: "text"
;
}
| {
altText?
: string
;
cache?
: boolean
;
details?
: "high"
| "low"
| "auto"
;
image
: string
;
mimeType
: string
;
optimize?
: "auto"
| "quality"
| "size"
;
type
: "image"
;
}
| {
cache?
: boolean
;
data
: string
;
duration?
: number
;
format?
: "wav"
| "mp3"
| "ogg"
;
transcription?
: string
;
type
: "audio"
;
}
| {
cache?
: boolean
;
data
: string
;
extractedText?
: string
;
filename
: string
;
mimeType
: string
;
type
: "file"
;
}
| {
cache?
: boolean
;
cachedContent?
: string
;
description?
: string
;
title?
: string
;
type
: "url"
;
url
: string
;
})[];
name?
: string
;
role
: "user"
;
}
| {
cache?
: boolean
;
content?
: string
;
functionCalls?
: object
[];
name?
: string
;
role
: "assistant"
;
})[]
renderExtraFields()
renderExtraFields(extraFields: readonly AxIField[]): (
| {
cache?: boolean;
text: string;
type: "text";
}
| {
altText?: string;
cache?: boolean;
details?: "high" | "low" | "auto";
image: string;
mimeType: string;
optimize?: "auto" | "quality" | "size";
type: "image";
}
| {
cache?: boolean;
data: string;
duration?: number;
format?: "wav" | "mp3" | "ogg";
transcription?: string;
type: "audio";
}
| {
cache?: boolean;
data: string;
extractedText?: string;
filename: string;
mimeType: string;
type: "file";
}
| {
cache?: boolean;
cachedContent?: string;
description?: string;
title?: string;
type: "url";
url: string;
})[];
Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/dsp/prompt.ts#L231
Parameters
Parameter | Type |
---|---|
extraFields | readonly AxIField [] |