Tools property types

[iztok]

What are the possible property types? I would like to define object and arrays.

As per the OpenAI API, we could define anything from a JSON schema, but NeuronAI\Tools\ToolProperty seems to limit us?

[ilvalerione]

Hi @iztok ,
do you have a link to a documentation?

[iztok]

The doc for function calling are here:
https://platform.openai.com/docs/guides/function-calling?api-mode=chat#defining-functions

parameters: [JSON schema](https://json-schema.org/) defining the function's input arguments

The motivation here is that I need a structured response from the LLM and I would use function call - sInce the NeuronAI\Chat\Messages\Message does not provide to get to "completion.choices[0].message.parsed"

[ilvalerione]

Ok! The actual implementation of the ToolProperty class is rigid. Anyway consider that I haven't tackled the structured response feature yet on any provider. It also require to change the API request's payload.

It's the next step in the roadmap and it could lead to necessary changes in these objects.

[iztok]

This does it for me:
https://github.com/inspector-apm/neuron-ai/pull/15/files

Implementation:

<?php

namespace App\Agents;

use NeuronAI\Agent;
use NeuronAI\Providers\OpenAI\OpenAI;
use NeuronAI\Providers\AIProviderInterface;

class LinkedInProfileResearcher extends Agent
{
    public function provider(): AIProviderInterface
    {
        $schema = [
            "name" => "linkedin_profile_summary",
            "strict" => true,
            'schema' => [
                'type' => 'object',
                'properties' => [
                    'bio' => [
                        'type' => 'string',
                        'description' => 'The bio of the person.'
                    ],
                    'areas_of_expertise' => [
                        'type' => 'array',
                        'description' => 'A list of areas of expertise of the person.',
                        'items' => [
                            'type' => 'string'
                        ]
                    ],
                    'companies' => [
                        'type' => 'array',
                        'description' => 'A list of companies the person works with.',
                        'items' => [
                            'type' => 'object',
                            'properties' => [
                                'name' => [
                                    'type' => 'string',
                                    'description' => 'The name of the company.'
                                ],
                                'website' => [
                                    'type' => 'string',
                                    'description' => 'The website of the company.'
                                ],
                                'linkedin_url' => [
                                    'type' => 'string',
                                    'description' => 'The LinkedIn URL related to the company.'
                                ]
                            ],
                            'required' => ['name', 'website', 'linkedin_url'],
                            'additionalProperties' => false
                        ]
                    ]
                ],
                'required' => ['bio', 'areas_of_expertise', 'companies'],
                'additionalProperties' => false
            ]
        ];

        return new OpenAI(
            key: config('services.openai.api_key'),
            model: 'gpt-4o-mini',
            additional_params: [
                'response_format' => [
                    'type' => 'json_schema',
                    'json_schema' => $schema,
                ]
            ]
        );
    }

    public function instructions(): string
    {
        return "Write detailed profile of a person based on the LinkedIn profile.";
    }
}

[ilvalerione]

The latest release 1.8.7 add support for structured response.

https://docs.neuron-ai.dev/components/ai-provider#structured-output