axGetCompatibilityReport

TypeScript

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

Defined in: https://github.com/ax-llm/ax/blob/5b28f9093bb70863b59459bb6df5062d005bce41/src/ax/ai/capabilities.ts#L537

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

TypeScript

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

Parameter	Type	Description
`request`	`AxChatRequest`	The chat request to analyze
`availableProviders`	`AxAIService`<`unknown`, `unknown`, `string`>[]	Array of available AI service providers

Returns

object

Comprehensive compatibility report with analysis and recommendations

Name	Type
`providerScores`	`ProviderCapabilityScore`[]
`recommendedProvider`	\| `null` \| `AxAIService`<`unknown`, `unknown`, `string`>
`requirements`	`MediaRequirements` & `object`
`summary`	`string`