relizy / AIConfig

Interface: AIConfig

Defined in: src/types.ts:965

Properties

extraGuidelines?

optional extraGuidelines?: string | AIExtraGuidelines

Defined in: src/types.ts:997

Extra directives appended to the built-in system prompts. A string applies to every target; an object adds directives per target, appended after the global ones.

Examples

'Always use emojis in the changelog'

{ global: 'Keep package names in English.', slack: 'Mention the owning team.' }

---

fallback?

optional fallback?: "raw" | "fail"

Defined in: src/types.ts:989

Behavior when the provider call fails.

• raw: fall back to the unmodified changelog body.
• fail: re-throw the error.

Default

'raw'

---

language?

optional language?: string

Defined in: src/types.ts:982

Output language (ISO 639-1 code or plain English name).

Default

'en'

---

provider?

optional provider?: AIProviderName

Defined in: src/types.ts:970

AI provider name

Default

'claude-code'

---

providerRelease?

optional providerRelease?: AITargetConfig

Defined in: src/types.ts:1006

Enable AI rewriting for GitHub/GitLab release notes.

---

providers?

optional providers?: object

Defined in: src/types.ts:974

Provider-specific options, keyed by provider name.

ai-sdk?

optional ai-sdk?: AiSdkProviderOptions

claude-code?

optional claude-code?: ClaudeCodeProviderOptions

---

social?

optional social?: AISocialConfig

Defined in: src/types.ts:1010

Enable AI rewriting for social media posts.

---

systemPromptOverrides?

optional systemPromptOverrides?: Partial<Record<AIPromptTarget, string>>

Defined in: src/types.ts:1002

Full replacement of the built-in system prompts. When set, the extraGuidelines and base prompts are ignored for that target.