Skip to content

Type Alias: ResolveChatWrapperOptions

ts
type ResolveChatWrapperOptions = {
  type:   | "auto"
     | SpecializedChatWrapperTypeName
     | TemplateChatWrapperTypeName;
  bosString: string | null;
  filename: string;
  fileInfo: GgufFileInfo;
  tokenizer: Tokenizer;
  customWrapperSettings: { [wrapper in keyof typeof chatWrappers]?: ConstructorParameters<typeof chatWrappers[wrapper]>[0] };
  warningLogs: boolean;
  fallbackToOtherWrappersOnJinjaError: boolean;
  noJinja: boolean;
};

Defined in: chatWrappers/utils/resolveChatWrapper.ts:70

Properties

type?

ts
optional type: 
  | "auto"
  | SpecializedChatWrapperTypeName
  | TemplateChatWrapperTypeName;

Defined in: chatWrappers/utils/resolveChatWrapper.ts:77

Resolve to a specific chat wrapper type. You better not set this option unless you need to force a specific chat wrapper type.

Defaults to "auto".


bosString?

ts
optional bosString: string | null;

Defined in: chatWrappers/utils/resolveChatWrapper.ts:79


filename?

ts
optional filename: string;

Defined in: chatWrappers/utils/resolveChatWrapper.ts:80


fileInfo?

ts
optional fileInfo: GgufFileInfo;

Defined in: chatWrappers/utils/resolveChatWrapper.ts:81


tokenizer?

ts
optional tokenizer: Tokenizer;

Defined in: chatWrappers/utils/resolveChatWrapper.ts:82


customWrapperSettings?

ts
optional customWrapperSettings: { [wrapper in keyof typeof chatWrappers]?: ConstructorParameters<typeof chatWrappers[wrapper]>[0] };

Defined in: chatWrappers/utils/resolveChatWrapper.ts:83


warningLogs?

ts
optional warningLogs: boolean;

Defined in: chatWrappers/utils/resolveChatWrapper.ts:90

Defaults to true.


fallbackToOtherWrappersOnJinjaError?

ts
optional fallbackToOtherWrappersOnJinjaError: boolean;

Defined in: chatWrappers/utils/resolveChatWrapper.ts:95

Defaults to true.


noJinja?

ts
optional noJinja: boolean;

Defined in: chatWrappers/utils/resolveChatWrapper.ts:102

Don't resolve to a Jinja chat wrapper unless type is set to a Jinja chat wrapper type.

Defaults to false.