axAnalyzeRequestRequirements Generated TypeScript API reference. typescript api api/reference build/apidocs/Function.axAnalyzeRequestRequirements.md function axAnalyzeRequestRequirements

axAnalyzeRequestRequirements

TypeScript
function axAnalyzeRequestRequirements(request: AxChatRequest): MediaRequirements & object;

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

Analyzes a chat request to determine what capabilities it requires from AI providers.

This function examines the request content to identify:

  • Media types (images, audio, files, URLs)
  • Function calling requirements
  • Streaming requirements
  • Caching requirements
  • Token usage estimation

Example

TypeScript
const requirements = axAnalyzeRequestRequirements({
  chatPrompt: [{
    role: 'user',
    content: [
      { type: 'text', text: 'Analyze this image:' },
      { type: 'image', image: 'base64...', details: 'high' }
    ]
  }]
});

console.log(requirements.hasImages); // true
console.log(requirements.estimatedTokens); // ~95

Parameters

ParameterTypeDescription
requestAxChatRequestThe chat request to analyze

Returns

MediaRequirements & object

Object containing detailed capability requirements and token estimation

Docs