axGetCompatibilityReport

function axGetCompatibilityReport(request: AxChatRequest, availableProviders: AxAIService<unknown, unknown, string>[]): object;

Defined in: https://github.com/ax-llm/ax/blob/9a5a7060a48f9eef46efc680b0cdf6b42bff5df2/src/ax/ai/capabilities.ts#L522

Generates a comprehensive compatibility report for a request across all providers.

Provides detailed analysis including requirement breakdown, provider scoring, recommendations, and human-readable compatibility summary.

Example

const report = axGetCompatibilityReport(request, [openai, gemini, cohere]);

console.log(report.summary); // "OpenAI supports 4/4 requirements (100% compatibility)"
console.log('Requirements:', report.requirements);

for (const score of report.providerScores) {
  console.log(`${score.provider.getName()}: ${score.score} points`);
  console.log(`  Missing: ${score.missingCapabilities.join(', ')}`);
}

Parameters

Returns

object

Comprehensive compatibility report with analysis and recommendations