@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
68 lines • 2.99 kB
TypeScript
import type { AgrInfoClient } from '../client';
import type { OllamaTag } from '../schemas';
type ExecuteRequest = AgrInfoClient['executeRequest'];
/**
* Creates the ollama resource methods
* OpenAPI Path: /ollama → ollama.*
* @description Ollama AI model management endpoints
*/
export declare function createOllamaResource(executeRequest: ExecuteRequest): {
/**
* Ollama tags endpoints
*/
tags: {
/**
* Get list of available Ollama AI model tags and versions
*
* @fullPath api.agrInfo.ollama.tags.list
* @service agr-info
* @domain ai-model-management
* @dataMethod ollamaData.tags.list
* @discoverable true
* @searchTerms ["ollama", "tags", "models", "ai", "versions", "available"]
* @relatedEndpoints ["api.agrInfo.akasha.generate.create", "api.agrInfo.joomla.generate.create"]
* @commonPatterns ["List AI models", "Available Ollama tags", "Model discovery"]
* @workflow ["model-discovery", "ai-setup", "model-selection"]
* @prerequisites ["Valid authentication", "Ollama service availability"]
* @nextSteps ["Select model for AI generation", "Configure AI workflows"]
* @businessRules ["Returns available model versions", "Includes model metadata", "Shows compatibility info"]
* @functionalArea "ai-model-management"
* @caching "Cache for 30 minutes, model availability changes slowly"
* @performance "Fast model listing, cached for efficiency"
*
* @returns Promise<OllamaTagsResponse> List of available Ollama model tags
*/
list: () => Promise<{
params: Record<string, unknown> | unknown[];
data: import("zod").objectInputType<{
name: import("zod").ZodString;
model: import("zod").ZodOptional<import("zod").ZodString>;
size: import("zod").ZodOptional<import("zod").ZodNumber>;
digest: import("zod").ZodOptional<import("zod").ZodString>;
modified_at: import("zod").ZodOptional<import("zod").ZodString>;
}, import("zod").ZodTypeAny, "passthrough">[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
}>;
};
};
/**
* Creates the ollamaData resource methods (data-only versions)
*/
export declare function createOllamaDataResource(ollama: ReturnType<typeof createOllamaResource>): {
tags: {
/**
* Get Ollama tags list data only
* @returns Promise<OllamaTag[]> Array of available Ollama model tags
*/
list: () => Promise<OllamaTag[]>;
};
};
export type OllamaResource = ReturnType<typeof createOllamaResource>;
export type OllamaDataResource = ReturnType<typeof createOllamaDataResource>;
export {};
//# sourceMappingURL=ollama.d.ts.map