Function toOpenAIToolDefinition

Convert from any tool call format to OpenAI format if possible

  • toOpenAIToolDefinition(
        toolDefinition: unknown,
    ):
        | null
        | objectOutputType<
            {
                function: ZodObject<
                    {
                        description: ZodOptional<ZodString>;
                        name: ZodString;
                        parameters: ZodObject<
                            {
                                additionalProperties: ZodOptional<ZodBoolean>;
                                properties: ZodRecord<ZodString, ZodUnion<[(...), (...)]>>;
                                required: ZodOptional<ZodArray<ZodString, "many">>;
                                type: ZodLiteral<"object">;
                            } & { strict: ZodOptional<ZodBoolean> },
                            "passthrough",
                            ZodTypeAny,
                            objectOutputType<
                                {
                                    additionalProperties: ZodOptional<ZodBoolean>;
                                    properties: ZodRecord<ZodString, ZodUnion<(...)>>;
                                    required: ZodOptional<ZodArray<(...), (...)>>;
                                    type: ZodLiteral<"object">;
                                } & { strict: ZodOptional<ZodBoolean> },
                                ZodTypeAny,
                                "passthrough",
                            >,
                            objectInputType<
                                {
                                    additionalProperties: ZodOptional<ZodBoolean>;
                                    properties: ZodRecord<ZodString, ZodUnion<(...)>>;
                                    required: ZodOptional<ZodArray<(...), (...)>>;
                                    type: ZodLiteral<"object">;
                                } & { strict: ZodOptional<ZodBoolean> },
                                ZodTypeAny,
                                "passthrough",
                            >,
                        >;
                    },
                    "passthrough",
                    ZodTypeAny,
                    objectOutputType<
                        {
                            description: ZodOptional<ZodString>;
                            name: ZodString;
                            parameters: ZodObject<
                                {
                                    additionalProperties: ZodOptional<ZodBoolean>;
                                    properties: ZodRecord<ZodString, ZodUnion<(...)>>;
                                    required: ZodOptional<ZodArray<(...), (...)>>;
                                    type: ZodLiteral<"object">;
                                } & { strict: ZodOptional<ZodBoolean> },
                                "passthrough",
                                ZodTypeAny,
                                objectOutputType<
                                    {
                                        additionalProperties: ZodOptional<(...)>;
                                        properties: ZodRecord<(...), (...)>;
                                        required: ZodOptional<(...)>;
                                        type: ZodLiteral<(...)>;
                                    } & { strict: ZodOptional<(...)> },
                                    ZodTypeAny,
                                    "passthrough",
                                >,
                                objectInputType<
                                    {
                                        additionalProperties: ZodOptional<(...)>;
                                        properties: ZodRecord<(...), (...)>;
                                        required: ZodOptional<(...)>;
                                        type: ZodLiteral<(...)>;
                                    } & { strict: ZodOptional<(...)> },
                                    ZodTypeAny,
                                    "passthrough",
                                >,
                            >;
                        },
                        ZodTypeAny,
                        "passthrough",
                    >,
                    objectInputType<
                        {
                            description: ZodOptional<ZodString>;
                            name: ZodString;
                            parameters: ZodObject<
                                {
                                    additionalProperties: ZodOptional<ZodBoolean>;
                                    properties: ZodRecord<ZodString, ZodUnion<(...)>>;
                                    required: ZodOptional<ZodArray<(...), (...)>>;
                                    type: ZodLiteral<"object">;
                                } & { strict: ZodOptional<ZodBoolean> },
                                "passthrough",
                                ZodTypeAny,
                                objectOutputType<
                                    {
                                        additionalProperties: ZodOptional<(...)>;
                                        properties: ZodRecord<(...), (...)>;
                                        required: ZodOptional<(...)>;
                                        type: ZodLiteral<(...)>;
                                    } & { strict: ZodOptional<(...)> },
                                    ZodTypeAny,
                                    "passthrough",
                                >,
                                objectInputType<
                                    {
                                        additionalProperties: ZodOptional<(...)>;
                                        properties: ZodRecord<(...), (...)>;
                                        required: ZodOptional<(...)>;
                                        type: ZodLiteral<(...)>;
                                    } & { strict: ZodOptional<(...)> },
                                    ZodTypeAny,
                                    "passthrough",
                                >,
                            >;
                        },
                        ZodTypeAny,
                        "passthrough",
                    >,
                >;
                type: ZodLiteral<"function">;
            },
            ZodTypeAny,
            "passthrough",
        >

    Parameters

    • toolDefinition: unknown

    Returns
        | null
        | objectOutputType<
            {
                function: ZodObject<
                    {
                        description: ZodOptional<ZodString>;
                        name: ZodString;
                        parameters: ZodObject<
                            {
                                additionalProperties: ZodOptional<ZodBoolean>;
                                properties: ZodRecord<ZodString, ZodUnion<[(...), (...)]>>;
                                required: ZodOptional<ZodArray<ZodString, "many">>;
                                type: ZodLiteral<"object">;
                            } & { strict: ZodOptional<ZodBoolean> },
                            "passthrough",
                            ZodTypeAny,
                            objectOutputType<
                                {
                                    additionalProperties: ZodOptional<ZodBoolean>;
                                    properties: ZodRecord<ZodString, ZodUnion<(...)>>;
                                    required: ZodOptional<ZodArray<(...), (...)>>;
                                    type: ZodLiteral<"object">;
                                } & { strict: ZodOptional<ZodBoolean> },
                                ZodTypeAny,
                                "passthrough",
                            >,
                            objectInputType<
                                {
                                    additionalProperties: ZodOptional<ZodBoolean>;
                                    properties: ZodRecord<ZodString, ZodUnion<(...)>>;
                                    required: ZodOptional<ZodArray<(...), (...)>>;
                                    type: ZodLiteral<"object">;
                                } & { strict: ZodOptional<ZodBoolean> },
                                ZodTypeAny,
                                "passthrough",
                            >,
                        >;
                    },
                    "passthrough",
                    ZodTypeAny,
                    objectOutputType<
                        {
                            description: ZodOptional<ZodString>;
                            name: ZodString;
                            parameters: ZodObject<
                                {
                                    additionalProperties: ZodOptional<ZodBoolean>;
                                    properties: ZodRecord<ZodString, ZodUnion<(...)>>;
                                    required: ZodOptional<ZodArray<(...), (...)>>;
                                    type: ZodLiteral<"object">;
                                } & { strict: ZodOptional<ZodBoolean> },
                                "passthrough",
                                ZodTypeAny,
                                objectOutputType<
                                    {
                                        additionalProperties: ZodOptional<(...)>;
                                        properties: ZodRecord<(...), (...)>;
                                        required: ZodOptional<(...)>;
                                        type: ZodLiteral<(...)>;
                                    } & { strict: ZodOptional<(...)> },
                                    ZodTypeAny,
                                    "passthrough",
                                >,
                                objectInputType<
                                    {
                                        additionalProperties: ZodOptional<(...)>;
                                        properties: ZodRecord<(...), (...)>;
                                        required: ZodOptional<(...)>;
                                        type: ZodLiteral<(...)>;
                                    } & { strict: ZodOptional<(...)> },
                                    ZodTypeAny,
                                    "passthrough",
                                >,
                            >;
                        },
                        ZodTypeAny,
                        "passthrough",
                    >,
                    objectInputType<
                        {
                            description: ZodOptional<ZodString>;
                            name: ZodString;
                            parameters: ZodObject<
                                {
                                    additionalProperties: ZodOptional<ZodBoolean>;
                                    properties: ZodRecord<ZodString, ZodUnion<(...)>>;
                                    required: ZodOptional<ZodArray<(...), (...)>>;
                                    type: ZodLiteral<"object">;
                                } & { strict: ZodOptional<ZodBoolean> },
                                "passthrough",
                                ZodTypeAny,
                                objectOutputType<
                                    {
                                        additionalProperties: ZodOptional<(...)>;
                                        properties: ZodRecord<(...), (...)>;
                                        required: ZodOptional<(...)>;
                                        type: ZodLiteral<(...)>;
                                    } & { strict: ZodOptional<(...)> },
                                    ZodTypeAny,
                                    "passthrough",
                                >,
                                objectInputType<
                                    {
                                        additionalProperties: ZodOptional<(...)>;
                                        properties: ZodRecord<(...), (...)>;
                                        required: ZodOptional<(...)>;
                                        type: ZodLiteral<(...)>;
                                    } & { strict: ZodOptional<(...)> },
                                    ZodTypeAny,
                                    "passthrough",
                                >,
                            >;
                        },
                        ZodTypeAny,
                        "passthrough",
                    >,
                >;
                type: ZodLiteral<"function">;
            },
            ZodTypeAny,
            "passthrough",
        >

Settings

Member Visibility