Skip to main content

​
ToolFunctionDefinition

Wraps a FunctionSchema inside a ToolFunction. Each tool in deployment.prompt.tools has a definition of this type.

​
Import

import type { ToolFunctionDefinition } from '@adaline/api';

​
Type Definition

interface ToolFunctionDefinition {
  schema: FunctionSchema;
}

​
Fields

​
schema
FunctionSchema
required
The FunctionSchema describing the function’s name, description, and parameters.

​
Example

import type { ToolFunctionDefinition, FunctionSchema } from '@adaline/api';

const definition: ToolFunctionDefinition = {
  schema: {
    name: 'search_database',
    description: 'Search internal knowledge base',
    parameters: {
      type: 'object',
      properties: {
        query: { type: 'string', description: 'Search query' },
        limit: { type: 'number', default: 10 }
      },
      required: ['query']
    }
  }
};

​
Accessing from a deployment

import { Adaline } from '@adaline/client';

const adaline = new Adaline();
const deployment = await adaline.getLatestDeployment({
  promptId: 'prompt_abc123',
  deploymentEnvironmentId: 'environment_abc123'
});

for (const tool of deployment.prompt.tools) {
  const { name, description } = tool.definition.schema;
  console.log(`${name}: ${description}`);
}